1 This is debbugs-ug.info, produced by makeinfo version 5.0 from
4 Copyright (C) 2015 Free Software Foundation, Inc.
6 Permission is granted to copy, distribute and/or modify this
7 document under the terms of the GNU Free Documentation License,
8 Version 1.2 or any later version published by the Free Software
9 Foundation; with no Invariant Sections, with the Front-Cover, or
10 Back-Cover Texts. A copy of the license is included in the section
11 entitled "GNU Free Documentation License" in the Emacs manual.
13 This document is part of a collection distributed under the GNU
14 Free Documentation License. If you want to distribute this
15 document separately from the collection, you can do so by adding a
16 copy of the license to the document, as described in section 6 of
19 All Emacs Lisp code contained in this document may be used,
20 distributed, and modified without restriction.
21 INFO-DIR-SECTION Emacs
23 * Debbugs UG: (debbugs-ug). Debbugs User Interface in Emacs.
27 File: debbugs-ug.info, Node: Top, Next: Retrieving Bugs, Up: (dir)
32 Debbugs is a bugtracking system (BTS) that was initially written for the
33 Debian project but currently used also by the GNU project. The main
34 distinctive feature of Debbugs is that it's mostly email-based. All
35 actions on bug reports: opening, closing, changing the status,
36 commenting, forwarding are performed via email by sending specially
37 composed letters to the particular mail addresses. However, searching
38 the bug reports, querying bug report status and viewing comments have
39 been web-based for a long time. To overcome this inconvenience the
40 Debbugs/SOAP service was introduced.
42 Based on the Debbugs/SOAP service, frontends are written which offer
43 handling of bugs inside Emacs. These frontends are restricted to the
44 GNU Debbugs server. Bugs are presented either as tabulated list
45 ('debbugs-gnu') or as 'org-mode' TODO list ('debbugs-org', *note Org
46 Mode: (org)Top.). As backend they use the 'debbugs' Emacs library
47 (*note Debbugs Programmer's Manual: (debbugs)Top.).
51 * Retrieving Bugs:: How to retrieve bugs.
52 * Searching Bugs:: How to search in the debbugs database.
53 * Layout:: How to results are presented.
55 * Command Index:: Debbugs commands.
56 * Variable Index:: User options and variables.
57 * Key Index:: Keyboard strokes on bug report buffers.
60 File: debbugs-ug.info, Node: Retrieving Bugs, Next: Searching Bugs, Prev: Top, Up: Top
65 Bugs are retrieved by the 'debbugs-gnu' or 'debbugs-org' commands. In
66 their simple version, they retrieve just bugs for the '"emacs"' package
67 on the GNU Debbugs server, filtered by bug severities. Further
68 filtering is possible when the commands are called with a prefix.
70 When the bug numbers to be retrieved are known, the commands
71 'debbugs-gnu-bugs' or 'debbugs-org-bugs' are applicable.
73 -- Command: debbugs-gnu severities &optional packages archivedp
75 -- Command: debbugs-org severities &optional packages archivedp
78 These commands retrieve bug reports from the GNU Debbugs server.
79 'debbugs-gnu' returns a tabulated list, and 'debbugs-org' returns a
80 list of TODO items in 'org-mode'. If there were more than
81 'debbugs-gnu-default-hits-per-page' bug results from the query,
82 there are widgets ('debbugs-gnu') or links ('debbugs-org') in the
83 result buffer for retrieving the other results.
85 SEVERITIES is a list of strings which filter for the severities of
86 the bugs to be retrieved. Valid severities are '"serious"',
87 '"important"', '"normal"', '"minor"' and '"wishlist"' (see also the
88 constant 'debbugs-gnu-all-severities'). If the list is empty,
89 there is no filtering with respect to severities. The keyword
90 '"tagged"', which is also possible, is not a severity in the GNU
91 Debbugs server but allows to restrict the result to bugs with a
94 PACKAGES, also a list of strings, point to the defined software
95 packages on the GNU Debbugs server which shall be taken into
96 account. The existing package names are compiled into the constant
97 'debbugs-gnu-all-packages'.
99 ARCHIVEDP, if non-'nil', extends the result also on archived bugs
100 on the GNU Debbugs server.
102 SUPPRESS shall also distinct between 'nil' and non-'nil'. When
103 non-'nil', closed bugs are suppressed from the results.
105 When SEVERITIES contains the severity '"tagged"', TAGS is consulted
106 in order to restrict the result on bugs which are tagged with one
107 of the strings of the list TAGS. This list can also be empty; in
108 this case locally tagged bugs are included into the results.
110 Called interactively, the commands require just the SEVERITIES and
111 the TAGS (if SEVERITIES includes '"tagged"'). In order to provide
112 the other arguments interactively, the commands must be called with
113 a prefix, like 'C-u M-x debbugs-gnu'. In the minibuffer, lists
114 must be entered comma-separated.
116 Default values for interactive use could be configured in the
117 customer options 'debbugs-gnu-default-severities' and
118 'debbugs-gnu-default-packages'.
120 When the result would exceed more than 500 bugs, the user is asked
121 how many bugs to retrieve at once. This value can be configured in
122 the customer option 'debbugs-gnu-default-hits-per-page'. However,
123 it is not recommended to exceeds the default value.
125 *note Layout:: for the presentation of the results.
127 -- Command: debbugs-gnu-bugs &rest bugs
128 -- Command: debbugs-org-bugs &rest bugs
130 The commands 'debbugs-gnu-bugs' and 'debbugs-org-bugs' show bugs
131 specified by their bug number. Interactively, the bug numbers must
132 be entered as comma-separated list.
134 *note Layout:: for the presentation of the results.
137 File: debbugs-ug.info, Node: Searching Bugs, Next: Layout, Prev: Retrieving Bugs, Up: Top
139 2 Searching in the Debbugs Database.
140 ************************************
142 The GNU Debbugs server allows full text search in the database. It uses
143 a HyperEstraier based search engine
144 (http://fallabs.com/hyperestraier/uguide-en.html#searchcond)(1).
146 -- Command: debbugs-gnu-search
147 -- Command: debbugs-org-search
149 These both commands are completely interactive. They ask for a
150 '"search phrase"' for the full text search. It is just a string
151 which contains the words to be searched for, combined by operators
152 like AND, ANDNOT and OR. If there is no operator between the words,
153 AND is used by default.
155 Wild card searches are also supported. It can be used for forward
156 match search and backward match search. For example, "[BW] euro"
157 matches words which begin with "euro". "[EW] shere" matches words
158 which end with "sphere". Moreover, regular expressions are also
159 supported. For example, "[RX] ^inter.*al$" matches words which
160 begin with "inter" and end with "al".(2)
162 While the words to be searched for are case insensitive, the
163 operators must be specified case sensitive.
165 While the search for the phrase is performed only in the bodies of
166 the messages belonging to a bug report, it is also possible to
167 discriminate the search to further bug attributes. The commands
168 ask for such key-value pairs, until an empty key is returned.
169 Possible attributes are
172 A comma-separated list of bug severities, *Note Retrieving
176 A comma-separated list of defined software packages on the GNU
177 Debbugs server, *Note Retrieving Bugs::.
180 A comma-separated list of defined user tags.
183 The address of the bug submitter.
186 A time period the bug has been in which the bug has been
187 submitted or modified.
190 Word(s) the subject of the bug report contains.
193 The status of the bug report. Valid values are "done",
194 "forwarded" and "open".
196 It is also possible to apply these commands with an empty search
197 phrase. In this case, the GNU Debbugs server is searched only for
198 bugs which fulfill the given attributes. The attributes to be
199 applied are the same as already described, plus
202 Whether archived bugs shall be searched (no value to be
206 Bugs which belong to a given source, if that attribute has
210 An arbitrary string the bug is annotated with. Usually, this
211 is the same as the status mentioned above.
216 The email address of the bug's owner, maintainer, or
217 correspondent (somebody who has participated in bug messages).
223 The date of the last update, or the date of the bug report /
227 The date the bug has been unarchived, if ever.
230 The email address of the worker who has closed the bug (if
234 A URL or an email address.
237 The message id of the initial bug report.
240 The summary of the bug report.
242 Not all of these attributes could be queried on the GNU Debbugs
243 server via the Debbugs/SOAP backend. In this case, the results of
244 a query are discriminated on the client side, which is indicated by
245 the string "(client-side filter)" in the minibuffer after the
248 ---------- Footnotes ----------
250 (1) This has been added to the Debbugs/SOAP backend of the GNU
253 (2) Simplified forms, as described in the Hyperestraier User Guide,
257 File: debbugs-ug.info, Node: Layout, Next: Command Index, Prev: Searching Bugs, Up: Top
262 The commands described in the previous chapters generate (a) report
263 buffer(s) applicable for navigation. 'debbugs-gnu-*' return a tabulated
264 list, and 'debbugs-org-*' return a list of TODO items in 'org-mode'.
268 * Tabulated Lists:: Tabulated Lists.
269 * TODO Items:: TODO Items.
270 * Control Messages:: Control Messages.
273 File: debbugs-ug.info, Node: Tabulated Lists, Next: TODO Items, Up: Layout
278 A tabulated list of bug reports consist of four columns for every bug
279 entry: 'Id' (the bug number), 'State' (some bug attributes), 'Submitter'
280 (the name of the bug submitter), and 'Title' (the bug subject). Per
281 default the bugs are sorted by 'Id'; this could be changed by clicking
284 Per bug retrieval only up to 500
285 ('debbugs-gnu-default-hits-per-page') bugs are retrieved and presented
286 in a buffer. If there shall be presented more bugs, widgets are placed
287 on the top and bottom of the buffer for navigation to further report
290 Different foreground colours present further information on the bug
291 report. If the bug number uses a red colour ('debbugs-gnu-tagged'), the
292 bug has been tagged locally. The same face is used to mark bugs in the
293 submitter or title column, when the bug has been reported / is
294 maintained by the user.
296 The bug state could appear in different colours: red
297 ('debbugs-gnu-new', nobody has answered yet to this bug), ForestGreen
298 ('debbugs-gnu-handled', the bug has been modified recently),
299 MidnightBlue ('debbugs-gnu-pending', the bug is pending), orange
300 ('debbugs-gnu-stale', the bug has not been touched for a while), and
301 DarkGrey ('debbugs-gnu-done', the bug is closed).
303 The bug report buffers have enabled the minor 'debbugs-gnu-mode'.
304 This enables the following key strokes:
306 '<RET>' 'debbugs-gnu-select-report'
307 '<mouse-1>' Open a GNUS ephemeral group for that bug.
310 'd' 'debbugs-gnu-display-status'
311 Show all bug attributes.
313 'g' 'debbugs-gnu-rescan'
314 Reload all bugs from the GNU Debbugs server.
316 'B' 'debbugs-gnu-show-blocking-reports'
317 'b' 'debbugs-gnu-show-blocked-by-reports'
318 Show all bug reports which are blocking / blocked by this bug.
320 's' 'debbugs-gnu-toggle-sort'
321 Toggle sorting order of bugs.
323 't' 'debbugs-gnu-toggle-tag'
324 Toggle local tag of bugs.
326 'x' 'debbugs-gnu-toggle-suppress'
327 Toggle showing of closed bugs.
329 'C' 'debbugs-gnu-send-control-message'
330 Send a control message for this bug, *note Control Messages::.
334 File: debbugs-ug.info, Node: TODO Items, Next: Control Messages, Prev: Tabulated Lists, Up: Layout
339 TODO items are offered as usual in 'org-mode'. The bug attributes are
340 mapped onto properties of these items. They can be shown by the usual
341 navigation in 'org-mode'.
343 Per bug retrieval only up to 500
344 ('debbugs-gnu-default-hits-per-page') bugs are retrieved and presented
345 in a buffer. At the end of the buffer there is a link, which allows to
346 append the next 500 bugs to the list.
348 Bug severities are mapped onto org severities, see
349 'debbugs-org-severity-priority'.
351 The bug report buffers have enabled the minor 'debbugs-gnu-mode'.
352 This enables the following key strokes:
355 Outline the bug report attributes in 'org-mode'.
357 'C-c # d' 'debbugs-gnu-display-status'
358 Show all bug attributes.
360 'C-c # t' 'debbugs-gnu-toggle-tag'
361 Toggle local tag of bugs.
363 'C-c # C' 'debbugs-gnu-send-control-message'
364 Send a control message for this bug, *note Control Messages::.
367 When the bug attributes are shown by 'org-cycle', there is a link
368 'Messages' which opens a GNUS ephemeral group for that bug.
371 File: debbugs-ug.info, Node: Control Messages, Prev: TODO Items, Up: Layout
376 Debbugs control messages are sent by email to the GNU Debbugs control
377 server. Their format is described in
378 <http://debbugs.gnu.org/server-control.html>.
380 A control message can be initiated in the tabulated list of bugs, in
381 the list of org TODO items, or in the GNUS ephemeral group opened for
382 the messages belonging to a given bug. In the minibuffer, the following
383 control messages can be requested (assuming that 12345 is the bug the
384 control message is intended for). The strings show the exact format of
385 the control messages.
389 "block|unblock 12345 by 54321"
391 The second bug number is read interactively. It could be also a
392 list of comma-separated bug numbers.
397 The second argument, the Emacs version, is read interactively.
409 "tags 12345 confirmed|fixed|help|moreinfo|notabug"
411 "tags 12345 patch|pending|security|unreproducible|wontfix"
417 "tags 12345 fixed|notabug|unreproducible|wontfix"
420 The second argument in the close message, the Emacs version, is
425 "forcemerge|merge 12345 54321"
427 The second bug number is read interactively.
434 "severity 12345 important|minor|normal|serious|wishlist"
448 "reassign 12345 PACKAGE"
450 The package name on the GNU Debbugs server is read interactively.
465 The username, read interactively, is either a package name or an
466 email address. The tag to be set is also read interactively.
469 File: debbugs-ug.info, Node: Command Index, Next: Variable Index, Prev: Layout, Up: Top