You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Chris Lawrence 3f7aa205c1 Fix. 18 years ago
debian Finalize 2.99.4 18 years ago
README.developers POSIX stuff. 19 years ago
TODO Add #271084 to TODO list. 18 years ago
build-stamp This commit was generated by cvs2svn to compensate for changes in r3, 19 years ago
checkbuildd.py This commit was generated by cvs2svn to compensate for changes in r3, 19 years ago
checkversions.py Changes for reportbug 2.52: added support for new p.d.o format. 19 years ago
debianbts.py Use CGI query that excludes list header and footer. 18 years ago
handle_bugscript Fix redirection bug which apparently emerged due to bash 3.0. 18 years ago
hiermatch.py This commit was generated by cvs2svn to compensate for changes in r3, 19 years ago
install-stamp This commit was generated by cvs2svn to compensate for changes in r3, 19 years ago
presubj This commit was generated by cvs2svn to compensate for changes in r3, 19 years ago
querybts Properly handle "no bugs found" in newt interface. 19 years ago
querybts.1 This commit was generated by cvs2svn to compensate for changes in r3, 19 years ago
rbtempfile.py Fix minor stupido. 18 years ago
reportbug Add paranoid mode support. 18 years ago
reportbug.1 Document --paranoid. 18 years ago
reportbug.conf Remove obsolete entries from reportbug.conf 18 years ago
reportbug.el This commit was generated by cvs2svn to compensate for changes in r3, 19 years ago
reportbug.py Add avail option to get_dpkg_status() 18 years ago
reportbug_exceptions.py Add NoMessage exception; comment out NotImplemented exception. 19 years ago
reportbug_submit.py Disable paranoia if in template or printonly mode. 18 years ago
reportbug_ui_gnome.py This commit was generated by cvs2svn to compensate for changes in r3, 19 years ago
reportbug_ui_newt.py Properly handle "no bugs found" in newt interface. 19 years ago
reportbug_ui_text.py Fix. 18 years ago
script This commit was generated by cvs2svn to compensate for changes in r3, 19 years ago
test_hiermatch.py This commit was generated by cvs2svn to compensate for changes in r3, 19 years ago
urllib2.py This commit was generated by cvs2svn to compensate for changes in r3, 19 years ago
urlutils.py Finalize 2.99.3. 18 years ago

README.developers

This file is lifted, almost verbatim, from "bug".

BUG'S Features for Developers
=============================


Bug allows maintainers to control the bug reporting process by placing
files in special places.

Template Information & Interaction with the user
================================================

If /usr/share/bug/$package is executable, then bug executes it and
takes what comes out from the file descriptor 3 and puts it in the bug
template.
The maintainer can then ask questions to the user or run whatever
information gathering script he likes, and echo all the content to fd 3.

e.g.:
read -p 'color? '
echo "Color: $REPLY" >&3
...
system-information-tool >&3

If /usr/share/bug/$package is a directory, then
/usr/share/bug/$package/script is executed.

While the script is executed, the following shell functions are
available:

getkey - asks for a key
yesno <prompt> "yep"|"nop" - ask for a yes/no answer (with i18n)
leaves response as yep or nop
in REPLY. The second argument is
the default.

If the file /usr/share/bug/$package/presubj exists, its content is
shown to the user before asking him for the bug's subject.

Note: It's your responsibility to check if the information included
in the template can put the user in any security risk.

Package redirection
===================

The package maintainer can control to which packages are the bug reports
submitted to (i.e. the Package: field of the report). This will be mainly
used to redirect bugs in packages coming from a single source to where the
maintainer likes to have them.


Submit-As: $new-package

Note that bug will not check if the $new-package exists as a valid package.

BTS selection
=============

Packages not distributed by Debian can take advantage of this utility too.
They just need to add a "send-to" header to the control file
/usr/share/bug/$package/control.

Send-To: bugs.myproject.com

`bug' will add `submit@' `quiet@' or `maintonly@' to form the address the
bug report mail is send to.

(Note: you probably should use dpkg's support for Origin and Bugs tags
in lieu of this support.)

Nicolás Lichtmaier.-
nick@debian.org

Related packages
================

Often programs are distributed across several different packages, for
example an upstream package 'foo' may be packaged in Debian as foo, libfoo,
foo-common and foo-data. In such cases it can be useful to include related
package information in bugreports, to minimise the need for 'moreinfo' requests
to the submitter :) This is done by adding a "report-with" header to the
control file.

report-with: foo libfoo foo-common foo-data

Package information will be added to the bug report for each extra package
listed.

Addendum: Languages other than SH
=================================

The script in /usr/share/bug/reportbug/script is an example of a bug
handling script written in Python. You can also write bug handlers in
many other languages that allow direct access to file descriptors,
including Perl and C/C++.