From 23a624ca1d40fa9cefd7229ac6152b79278a6517 Mon Sep 17 00:00:00 2001 From: Michael Albinus Date: Wed, 1 Apr 2015 13:57:54 +0200 Subject: [PATCH] Add *.info and dir to debbugs --- packages/debbugs/debbugs-ug.info | 540 ++++++++++++++++++++++++++++++ packages/debbugs/debbugs.info | 541 +++++++++++++++++++++++++++++++ packages/debbugs/dir | 23 ++ 3 files changed, 1104 insertions(+) create mode 100644 packages/debbugs/debbugs-ug.info create mode 100644 packages/debbugs/debbugs.info create mode 100644 packages/debbugs/dir diff --git a/packages/debbugs/debbugs-ug.info b/packages/debbugs/debbugs-ug.info new file mode 100644 index 000000000..0e0b1e446 --- /dev/null +++ b/packages/debbugs/debbugs-ug.info @@ -0,0 +1,540 @@ +This is debbugs-ug.info, produced by makeinfo version 5.0 from +debbugs-ug.texi. + +Copyright (C) 2015 Free Software Foundation, Inc. + + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation License, + Version 1.2 or any later version published by the Free Software + Foundation; with no Invariant Sections, with the Front-Cover, or + Back-Cover Texts. A copy of the license is included in the section + entitled "GNU Free Documentation License" in the Emacs manual. + + This document is part of a collection distributed under the GNU + Free Documentation License. If you want to distribute this + document separately from the collection, you can do so by adding a + copy of the license to the document, as described in section 6 of + the license. + + All Emacs Lisp code contained in this document may be used, + distributed, and modified without restriction. +INFO-DIR-SECTION Emacs +START-INFO-DIR-ENTRY +* Debbugs UG: (debbugs-ug). Debbugs User Interface in Emacs. +END-INFO-DIR-ENTRY + + +File: debbugs-ug.info, Node: Top, Next: Retrieving Bugs, Up: (dir) + +Debbugs User Guide +****************** + +Debbugs is a bugtracking system (BTS) that was initially written for the +Debian project but actually used also by the GNU project. The main +distinctive feature of Debbugs is that it's mostly email-based. All +actions on bug reports: opening, closing, changing the status, +commenting, forwarding are performed via email by sending specially +composed letters to the particular mail addresses. However, searching +the bug reports, querying bug report status and viewing comments have +been web-based for a long time. To overcome this inconvenience the +Debbugs/SOAP service was introduced. + + Based on the Debbugs/SOAP service, frontends are written which offer +handling of bugs inside Emacs. These frontends are restricted to the +GNU Debbugs server. Bugs are presented either as tabulated list +('debbugs-gnu') or as 'org-mode' TODO list ('debbugs-org', *note Org +Mode: (org)Top.). As backend they use the 'debbugs' Emacs library +(*note Debbugs Programmer's Manual: (debbugs)Top.). + +* Menu: + +* Retrieving Bugs:: How to retrieve bugs. +* Searching Bugs:: How to search in the debbugs database. +* Layout:: How to results are presented. + +* Command Index:: Debbugs commands. +* Variable Index:: User options and variables. +* Key Index:: Keyboard strokes on bug report buffers. + + +File: debbugs-ug.info, Node: Retrieving Bugs, Next: Searching Bugs, Prev: Top, Up: Top + +1 Retrieving Bugs +***************** + +Bugs are retrieved by the 'debbugs-gnu' or 'debbugs-org' commands. In +their simple version, they retrieve just bugs for the '"emacs"' package +on the GNU Debbugs server, filtered by bug severities. Further +filtering is possible when the commands are called with a prefix. + + When the bug numbers to be retrieved are known, the commands +'debbugs-gnu-bugs' or 'debbugs-org-bugs' are applicable. + + -- Command: debbugs-gnu severities &optional packages archivedp + suppress tags + -- Command: debbugs-org severities &optional packages archivedp + suppress tags + + These commands retrieve bug reports from the GNU Debbugs server. + 'debbugs-gnu' returns a tabulated list, and 'debbugs-org' returns a + list of TODO items in 'org-mode'. If there were more than + 'debbugs-gnu-default-hits-per-page' bug results from the query, + there are widgets ('debbugs-gnu') or links ('debbugs-org') in the + result buffer for retrieving the other results. + + SEVERITIES is a list of strings which filter for the severities of + the bugs to be retrieved. Valid severities are '"serious"', + '"important"', '"normal"', '"minor"' and '"wishlist"' (see also the + constant 'debbugs-gnu-all-severities'). If the list is empty, + there is no filtering with respect to severities. The keyword + '"tagged"', which is also possible, is not a severity in the GNU + Debbugs server but allows to restrict the result to bugs with a + given user tag. + + PACKAGES, also a list of strings, point to the defined software + packages on the GNU Debbugs server which shall be taken into + account. The existing package names are compiled into the constant + 'debbugs-gnu-all-packages'. + + ARCHIVEDP, if non-'nil', extends the result also on archived bugs + on the GNU Debbugs server. + + SUPPRESS shall also distinct between 'nil' and non-'nil'. When + non-'nil', closed bugs are suppressed from the results. + + When SEVERITIES contains the severity '"tagged"', TAGS is consulted + in order to restrict the result on bugs which are tagged with one + of the strings of the list TAGS. This list can also be empty; in + this case locally tagged bugs are included into the results. + + Called interactively, the commands require just the SEVERITIES and + the TAGS (if SEVERITIES includes '"tagged"'). In order to provide + the other arguments interactively, the commands must be called with + a prefix, like 'C-u M-x debbugs-gnu'. In the minibuffer, lists + must be entered comma-separated. + + Default values for interactive use could be configured in the + customer options 'debbugs-gnu-default-severities' and + 'debbugs-gnu-default-packages'. + + When the result would exceed more than 500 bugs, the user is asked + how many bugs to retrieve at once. This value can be configured in + the customer option 'debbugs-gnu-default-hits-per-page'. However, + it is not recommended to exceeds the default value. + + *note Layout:: for the presentation of the results. + + -- Command: debbugs-gnu-bugs &rest bugs + -- Command: debbugs-org-bugs &rest bugs + + The commands 'debbugs-gnu-bugs' and 'debbugs-org-bugs' show bugs + specified by their bug number. Interactively, the bug numbers must + be entered as comma-separated list. + + *note Layout:: for the presentation of the results. + + +File: debbugs-ug.info, Node: Searching Bugs, Next: Layout, Prev: Retrieving Bugs, Up: Top + +2 Searching in the Debbugs Database. +************************************ + +The GNU Debbugs server allows full text search in the database. It uses +a HyperEstraier based search engine +(http://fallabs.com/hyperestraier/uguide-en.html#searchcond)(1). + + -- Command: debbugs-gnu-search + -- Command: debbugs-org-search + + These both commands are completely interactive. They ask for a + '"search phrase"' for the full text search. It is just a string + which contains the words to be searched for, combined by operators + like AND, ANDNOT and OR. If there is no operator between the words, + AND is used by default. + + Wild card searches are also supported. It can be used for forward + match search and backward match search. For example, "[BW] euro" + matches words which begin with "euro". "[EW] shere" matches words + which end with "sphere". Moreover, regular expressions are also + supported. For example, "[RX] ^inter.*al$" matches words which + begin with "inter" and end with "al".(2) + + While the words to be searched for are case insensitive, the + operators must be specified case sensitive. + + While the search for the phrase is performed only in the bodies of + the messages belonging to a bug report, it is also possible to + discriminate the search to further bug attributes. The commands + ask for such key-value pairs, until an empty key is returned. + Possible attributes are + + 'severity' + A comma-separated list of bug severities, *Note Retrieving + Bugs::. + + 'package' + A comma-separated list of defined software packages on the GNU + Debbugs server, *Note Retrieving Bugs::. + + 'tags' + A comma-separated list of defined user tags. + + 'submitter' + The address of the bug submitter. + + 'date' + A time period the bug has been in which the bug has been + submitted or modified. + + 'subject' + Word(s) the subject of the bug report contains. + + 'status' + The status of the bug report. Valid values are "done", + "forwarded" and "open". + + It is also possible to apply these commands with an empty search + phrase. In this case, the GNU Debbugs server is searched only for + bugs which fulfill the given attributes. The attributes to be + applied are the same as already described, plus + + 'archive' + Whether archived bugs shall be searched (no value to be + entered). + + 'src' + Bugs which belong to a given source, if that attribute has + set. + + 'tag' + An arbitrary string the bug is annotated with. Usually, this + is the same as the status mentioned above. + + 'owner' + 'maint' + 'correspondent' + The email address of the bug's owner, maintainer, or + correspondent (somebody who has participated in bug messages). + + 'log_modified' + 'last_modified' + 'found_date' + 'fixed_date' + The date of the last update, or the date of the bug report / + bug fix. + + 'unarchived' + The date the bug has been unarchived, if ever. + + 'done' + The email address of the worker who has closed the bug (if + done). + + 'forwarded' + A URL or an email address. + + 'msgid' + The message id of the initial bug report. + + 'summary' + The summary of the bug report. + + Not all of these attributes could be queried on the GNU Debbugs + server via the Debbugs/SOAP backend. In this case, the results of + a query are discriminated on the client side, which is indicated by + the string "(client-side filter)" in the minibuffer after the + attribute name. + + ---------- Footnotes ---------- + + (1) This has been added to the Debbugs/SOAP backend of the GNU +Debbugs server only. + + (2) Simplified forms, as described in the Hyperestraier User Guide, +are not supported. + + +File: debbugs-ug.info, Node: Layout, Next: Command Index, Prev: Searching Bugs, Up: Top + +3 Layout +******** + +The commands described in the previous chapters generate (a) report +buffer(s) applicable for navigation. 'debbugs-gnu-*' return a tabulated +list, and 'debbugs-org-*' return a list of TODO items in 'org-mode'. + +* Menu: + +* Tabulated Lists:: Tabulated Lists. +* TODO Items:: TODO Items. +* Control Messages:: Control Messages. + + +File: debbugs-ug.info, Node: Tabulated Lists, Next: TODO Items, Up: Layout + +3.1 Tabulated Lists +=================== + +A tabulated list of bug reports consist of four columns for every bug +entry: 'Id' (the bug number), 'State' (some bug attributes), 'Submitter' +(the name of the bug submitter), and 'Title' (the bug subject). Per +default the bugs are sorted by 'Id'; this could be changed by clicking +in the headline. + + Per bug retrieval only up to 500 +('debbugs-gnu-default-hits-per-page') bugs are retrieved and presented +in a buffer. If there shall be presented more bugs, widgets are placed +on the top and bottom of the buffer for navigation to further report +buffers. + + Different foreground colours present further information on the bug +report. If the bug number uses a red colour ('debbugs-gnu-tagged'), the +bug has been tagged locally. The same face is used to mark bugs in the +submitter or title column, when the bug has been reported / is +maintained by the user. + + The bug state could appear in different colours: red +('debbugs-gnu-new', nobody has answered yet to this bug), ForestGreen +('debbugs-gnu-handled', the bug has been modified recently), +MidnightBlue ('debbugs-gnu-pending', the bug is pending), orange +('debbugs-gnu-stale', the bug has not been touched for a while), and +DarkGrey ('debbugs-gnu-done', the bug is closed). + + The bug report buffers have enabled the minor 'debbugs-gnu-mode'. +This enables the following key strokes: + +'' 'debbugs-gnu-select-report' +'' Open a GNUS ephemeral group for that bug. +'' + +'d' 'debbugs-gnu-display-status' + Show all bug attributes. + +'g' 'debbugs-gnu-rescan' + Reload all bugs from the GNU Debbugs server. + +'B' 'debbugs-gnu-show-blocking-reports' +'b' 'debbugs-gnu-show-blocked-by-reports' + Show all bug reports which are blocking / blocked by this bug. + +'s' 'debbugs-gnu-toggle-sort' + Toggle sorting order of bugs. + +'t' 'debbugs-gnu-toggle-tag' + Toggle local tag of bugs. + +'x' 'debbugs-gnu-toggle-suppress' + Toggle showing of closed bugs. + +'C' 'debbugs-gnu-send-control-message' + Send a control message for this bug, *note Control Messages::. + + + +File: debbugs-ug.info, Node: TODO Items, Next: Control Messages, Prev: Tabulated Lists, Up: Layout + +3.2 TODO Items +============== + +TODO items are offered as usual in 'org-mode'. The bug attributes are +mapped onto properties of these items. They can be shown by the usual +navigation in 'org-mode'. + + Per bug retrieval only up to 500 +('debbugs-gnu-default-hits-per-page') bugs are retrieved and presented +in a buffer. At the end of the buffer there is a link, which allows to +append the next 500 bugs to the list. + + Bug severities are mapped onto org severities, see +'debbugs-org-severity-priority'. + + The bug report buffers have enabled the minor 'debbugs-gnu-mode'. +This enables the following key strokes: + +'' 'org-cycle' + Outline the bug report attributes in 'org-mode'. + +'C-c # d' 'debbugs-gnu-display-status' + Show all bug attributes. + +'C-c # t' 'debbugs-gnu-toggle-tag' + Toggle local tag of bugs. + +'C-c # C' 'debbugs-gnu-send-control-message' + Send a control message for this bug, *note Control Messages::. + + + When the bug attributes are shown by 'org-cycle', there is a link +'Messages' which opens a GNUS ephemeral group for that bug. + + +File: debbugs-ug.info, Node: Control Messages, Prev: TODO Items, Up: Layout + +3.3 Control Messages +==================== + +Debbugs control messages are sent by email to the GNU Debbugs control +server. Their format is described in +. + + A control message can be initiated in the tabulated list of bugs, in +the list of org TODO items, or in the GNUS ephemeral group opened for +the messages belonging to a given bug. In the minibuffer, the following +control messages can be requested (assuming that 12345 is the bug the +control message is intended for). The strings show the exact format of +the control messages. + +'block' +'unblock' + "block|unblock 12345 by 54321" + + The second bug number is read interactively. It could be also a + list of comma-separated bug numbers. + +'close' + "close 12345 25.1" + + The second argument, the Emacs version, is read interactively. + +'confirmed' +'fixed' +'help' +'moreinfo' +'notabug' +'patch' +'pending' +'security' +'unreproducible' +'wontfix' + "tags 12345 confirmed|fixed|help|moreinfo|notabug" + + "tags 12345 patch|pending|security|unreproducible|wontfix" + +'done' +'donenotabug' +'doneunreproducible' +'donewontfix' + "tags 12345 fixed|notabug|unreproducible|wontfix" + "close 12345 25.1" + + The second argument in the close message, the Emacs version, is + read interactively. + +'forcemerge' +'merge' + "forcemerge|merge 12345 54321" + + The second bug number is read interactively. + +'important' +'minor' +'normal' +'serious' +'wishlist' + "severity 12345 important|minor|normal|serious|wishlist" + +'invalid' + "tags 12345 notabug" + "tags 12345 wontfix" + "close 12345" + +'noowner' + "noowner 12345" + +'owner' + "owner 12345 !" + +'reassign' + "reassign 12345 PACKAGE" + + The package name on the GNU Debbugs server is read interactively. + +'reopen' + "reopen 12345" + +'unarchive' + "unarchive 12345" + +'unmerge' + "unmerge 12345" + +'usertag' + "user USERNAME" + "usertag 12345 TAG" + + The username, read interactively, is either a package name or an + email address. The tag to be set is also read interactively. + + +File: debbugs-ug.info, Node: Command Index, Next: Variable Index, Prev: Layout, Up: Top + +Command Index +************* + +[index] +* Menu: + +* debbugs-gnu: Retrieving Bugs. (line 14) +* debbugs-gnu-bugs: Retrieving Bugs. (line 68) +* debbugs-gnu-search: Searching Bugs. (line 10) +* debbugs-org: Retrieving Bugs. (line 16) +* debbugs-org-bugs: Retrieving Bugs. (line 69) +* debbugs-org-search: Searching Bugs. (line 11) + + +File: debbugs-ug.info, Node: Variable Index, Next: Key Index, Prev: Command Index, Up: Top + +Variable Index +************** + +[index] +* Menu: + +* debbugs-gnu-all-packages: Retrieving Bugs. (line 35) +* debbugs-gnu-all-severities: Retrieving Bugs. (line 26) +* debbugs-gnu-default-hits-per-page: Retrieving Bugs. (line 61) +* debbugs-gnu-default-packages: Retrieving Bugs. (line 57) +* debbugs-gnu-default-severities: Retrieving Bugs. (line 57) + + +File: debbugs-ug.info, Node: Key Index, Prev: Variable Index, Up: Top + +Key Index +********* + +[index] +* Menu: + +* 'B': Tabulated Lists. (line 44) +* 'b': Tabulated Lists. (line 45) +* 'C': Tabulated Lists. (line 57) +* 'C-c # C': TODO Items. (line 30) +* 'C-c # d': TODO Items. (line 24) +* 'C-c # t': TODO Items. (line 27) +* 'd': Tabulated Lists. (line 38) +* 'g': Tabulated Lists. (line 41) +* '': Tabulated Lists. (line 34) +* '': Tabulated Lists. (line 36) +* '': Tabulated Lists. (line 34) +* 's': Tabulated Lists. (line 48) +* 't': Tabulated Lists. (line 51) +* '': TODO Items. (line 21) +* 'x': Tabulated Lists. (line 54) + + + +Tag Table: +Node: Top1087 +Node: Retrieving Bugs2563 +Node: Searching Bugs6085 +Ref: Searching Bugs-Footnote-19954 +Ref: Searching Bugs-Footnote-210042 +Node: Layout10133 +Node: Tabulated Lists10611 +Node: TODO Items13045 +Node: Control Messages14310 +Node: Command Index16470 +Node: Variable Index17054 +Node: Key Index17570 + +End Tag Table diff --git a/packages/debbugs/debbugs.info b/packages/debbugs/debbugs.info new file mode 100644 index 000000000..95c53726a --- /dev/null +++ b/packages/debbugs/debbugs.info @@ -0,0 +1,541 @@ +This is debbugs.info, produced by makeinfo version 5.0 from +debbugs.texi. + +Copyright (C) 2011-2015 Free Software Foundation, Inc. + + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation License, + Version 1.2 or any later version published by the Free Software + Foundation; with no Invariant Sections, with the Front-Cover, or + Back-Cover Texts. A copy of the license is included in the section + entitled "GNU Free Documentation License" in the Emacs manual. + + This document is part of a collection distributed under the GNU + Free Documentation License. If you want to distribute this + document separately from the collection, you can do so by adding a + copy of the license to the document, as described in section 6 of + the license. + + All Emacs Lisp code contained in this document may be used, + distributed, and modified without restriction. +INFO-DIR-SECTION Emacs +START-INFO-DIR-ENTRY +* Debbugs: (debbugs). A library for communication with Debbugs. +END-INFO-DIR-ENTRY + + +File: debbugs.info, Node: Top, Next: Installation, Up: (dir) + +Debbugs Programmer's Manual +*************************** + +Debbugs is a bugtracking system (BTS) that was initially written for the +Debian project but actually used also by the GNU project. The main +distinctive feature of Debbugs is that it's mostly email-based. All +actions on bug reports: opening, closing, changing the status, +commenting, forwarding are performed via email by sending specially +composed letters to the particular mail addresses. However, searching +the bug reports, querying bug report status and viewing comments have +been web-based for a long time. To overcome this inconvenience the +Debbugs/SOAP service was introduced. + + The Debbugs/SOAP service provides the means for developers to write +client applications that can send the queries with certain search +criteria to the Debbugs server and retrieve a set of bug reports that +match them. The developer may also ask the Debbugs server for +additional information about every bug report (e.g. subject, date, +originator, tags and etc.) and get all comments and attachments. + + 'debbugs', described in this document, is the Emacs library that +exposes to developers the available functions provided by the Debbugs +server. 'debbugs' uses Emacs' SOAP client library for communication +with the Debbugs server. In tandem with Emacs' email facilities, +'debbugs' provides a solution for building applications that interact +with the Debbugs BTS directly from Emacs without addressing Debbugs' web +interface. + +* Menu: + +* Installation:: Getting and installing 'debbugs'. +* Configuration:: Configuring 'debbugs'. +* Requesting bug numbers:: How to request bug report numbers. +* Requesting bugs statuses:: How to request the status of bug reports. +* Requesting messages:: How to get messages from bug reports. +* Requesting user tags:: How to request tags set by users. + + +File: debbugs.info, Node: Installation, Next: Configuration, Prev: Top, Up: Top + +1 Installation +************** + +Installation on Emacs 24 or later +--------------------------------- + +Install 'debbugs' from the *note ELPA repository: (elisp)Packaging. + +Installation on Emacs 22 and Emacs 23 +------------------------------------- + +If you want to install 'debbugs' on Emacs 22/23, you will need to +install the 'soap-client' library first. It can be downloaded from the +Emacs SOAP client project page +(http://code.google.com/p/emacs-soap-client/). + + Compile the library and add it into your 'load-path': + + (add-to-list 'load-path "/path/to/emacs-soap-client/") + + 'debbugs' library can be downloaded from the ELPA repository +(http://elpa.gnu.org/packages/). Compile it and set the 'load-path': + + (add-to-list 'load-path "/path/to/debbugs/") + +Installation on Emacs 21 +------------------------ + +We have not tried yet to install 'debbugs' on Emacs 21. We would +definitely say that the installation will require even more additional +libraries than needed for installation on Emacs 22/23. + + +File: debbugs.info, Node: Configuration, Next: Requesting bug numbers, Prev: Installation, Up: Top + +2 Configuration +*************** + +'debbugs' is already configured to work with two main ports of Debbugs +BTS: and . So if you +intend to use one of these ports, you don't need to configure 'debbugs'. +If you want to interact with a Debbugs port other than those listed, you +have to configure 'debbugs' by adding a new server specifier to the +'debbugs-servers' variable. The actual port can be selected by the +'debbugs-port' variable. + + -- Variable: debbugs-servers + List of Debbugs server specifiers. Each entry is a list that + contains a string identifying the port name and the server + parameters in keyword-value form. The list initially contains two + predefined and configured Debbugs servers: '"gnu.org"' and + '"debian.org"'. + + Valid keywords are: + + ':wsdl' + Location of WSDL. The value is a string with the URL that + should return the WSDL specification of the Debbugs/SOAP + service. This keyword is intended for future use, it is + ignored currently. + + ':bugreport-url' + The URL of the server script ('bugreport.cgi' in the default + Debbugs installation) that provides the access to mboxes with + messages from bug reports. + + Example. Add a new Debbugs port with name "foobars.net": + + (add-to-list + 'debbugs-servers + '("foobars.net" + :wsdl "http://bugs.foobars.net/cgi/soap.cgi?WSDL" + :bugreport-url "http://bugs.foobars.net/cgi/bugreport.cgi")) + + -- Variable: debbugs-port + This variable holds the name of the currently used port. The value + of the variable corresponds to the Debbugs server to be accessed, + either '"gnu.org"' or '"debian.org"', or a user defined port name. + + +File: debbugs.info, Node: Requesting bug numbers, Next: Requesting bugs statuses, Prev: Configuration, Up: Top + +3 Requesting bug numbers +************************ + +In Debbugs BTS, the bug number is the unique identifier of a bug report. +The functions described in this section return from the Debbugs server +the list of bug numbers that match a user's query. + + -- Function: debbugs-get-bugs &rest query + This function returns a list of bug numbers that match the QUERY. + QUERY is a sequence of keyword-value pairs where the values are + strings, i.e. :KEYWORD "VALUE" [:KEYWORD "VALUE"]* + + The keyword-value pair is a subquery. The keywords are allowed to + have multiple occurrence within the query at any place. The + subqueries with the same keyword form the logical subquery, which + returns the union of bugs of every subquery it contains. + + The result of the QUERY is an intersection of results of all + subqueries. + + Valid keywords are: + + ':package' + The value is the name of the package a bug belongs to, like + '"emacs"', '"coreutils"', '"gnus"', or '"tramp"'. + + ':src' + This is used to retrieve bugs that belong to source with given + name. + + ':severity' + This is the severity of the bug. The exact set of available + severities depends on the policy of a particular Debbugs port: + + Debian port: '"critical"', '"grave"', '"serious"', + '"important"', '"normal"', '"minor"', '"wishlist"', and + '"fixed"'. + + GNU port: '"serious"', '"important"', '"normal"', '"minor"', + '"wishlist"'. + + ':tag' + An arbitrary string the bug is annotated with. Usually, this + is used to mark the status of the bug. The list of possible + tags depends on the Debbugs port. + + Debian port: '"patch"', '"wontfix"', '"moreinfo"', + '"unreproducible"', '"fixed"', '"potato"', '"woody"', '"sid"', + '"help"', '"security"', '"upstream"', '"pending"', '"sarge"', + '"sarge-ignore"', '"experimental"', '"d-i"', '"confirmed"', + '"ipv6"', '"lfs"', '"fixed-in-experimental"', + '"fixed-upstream"', '"l10n"', '"etch"', '"etch-ignore"', + '"lenny"', '"lenny-ignore"', '"squeeze"', '"squeeze-ignore"', + '"wheezy"', '"wheezy-ignore"'. The actual list of tags can be + found on . + + GNU port: '"fixed"', '"notabug"', '"wontfix"', + '"unreproducible"', '"moreinfo"', '"patch"', '"pending"', + '"help"', '"security"', '"confirmed"'. See + for the actual + list of tags. + + ':owner' + This is used to identify bugs by the owner's email address. + The special email address '"me"' is used as pattern, replaced + with the variable 'user-mail-address' (*note (elisp)User + Identification::). + + ':submitter' + With this keyword it is possible to filter bugs by the + submitter's email address. The special email address '"me"' + is used as pattern, replaced with the variable + 'user-mail-address'. + + ':maint' + This is used to find bugs of the packages which are maintained + by the person with the given email address. The special email + address '"me"' is used as pattern, replaced with + 'user-mail-address'. + + ':correspondent' + This allows to find bug reports where the person with the + given email address has participated. The special email + address '"me"' is used as pattern, replaced with + 'user-mail-address'. + + ':affects' + With this keyword it is possible to find bugs which affect the + package with the given name. The bugs are chosen by the value + of field 'affects' in bug's status. The returned bugs do not + necessary belong to this package. + + ':status' + Status of bug. Valid values are '"done"', '"forwarded"' and + '"open"'. + + ':archive' + A keyword to filter for bugs which are already archived, or + not. Valid values are '"0"' (not archived), '"1"' (archived) + or '"both"'. If this keyword is not given in the query, + ':archive "0"' is assumed by default. + + Example. Get all opened and forwarded release critical bugs for + the packages which are maintained by '"me"' and which have a patch: + + (let ((debbugs-port "debian.org")) + (debbugs-get-bugs :maint "me" :tag "patch" + :severity "critical" + :status "open" + :severity "grave" + :status "forwarded" + :severity "serious")) + + -- Function: debbugs-newest-bugs amount + This function returns a list of bug numbers, according to AMOUNT (a + number) of latest bugs. + + Example. Get the latest six bug report numbers from Debian BTS: + + (let ((debbugs-port "debian.org")) + (debbugs-newest-bugs 6)) + => (633152 633153 633154 633155 633156 633157) + + +File: debbugs.info, Node: Requesting bugs statuses, Next: Requesting messages, Prev: Requesting bug numbers, Up: Top + +4 Requesting bugs statuses +************************** + +Bug status is a collection of fields that holds the information about +the state and importance of the bug report, about originator, owner and +various aspects of relationship with other bug reports. + + -- Function: debbugs-get-status &rest bug-numbers + Return a list of status entries for the bug reports identified by + BUG-NUMBERS. Every returned entry is an association list with the + following attributes: + + 'id' + 'bug_num' + The bug number. + + 'package' + A list of package names the bug belongs to. + + 'severity' + The severity of the bug report. Possible values are the same + as for ':severity' in 'debbugs-get-bugs' (*note Requesting bug + numbers::). + + 'tags' + The status of the bug report, a list of strings. Possible + values are the same as for ':tags' in 'debbugs-get-bugs' + (*note Requesting bug numbers::). + + 'pending' + The string '"pending"', '"forwarded"' or '"done"'. + + 'subject' + Subject/Title of the bugreport. + + 'originator' + The E-mail address of the bug report submitter. + + 'mergedwith' + A list of bug numbers this bug was merged with. + + 'source' + Source package name of the bug report. + + 'date' + Date of bug creation. Encoded as UNIX time. + + 'log_modified' + 'last_modified' + Date of last update. Encoded as UNIX time. + + 'found_date' + 'fixed_date' + Date of bug report / bug fix (empty for now). Encoded as UNIX + time. + + 'done' + The E-mail address of the worker who has closed the bug (if + done). + + 'archived' + 't' if the bug is archived, 'nil' otherwise. + + 'unarchived' + The date the bug has been unarchived, if ever. Encoded as + UNIX time. + + 'found_versions' + 'fixed_versions' + List of version strings. + + 'forwarded' + A URL or an E-mail address. + + 'blocks' + A list of bug numbers this bug blocks. + + 'blockedby' + A list of bug numbers this bug is blocked by. + + 'msgid' + The message id of the initial bug report. + + 'owner' + Who is responsible for fixing. + + 'location' + Always the string '"db-h"' or '"archive"'. + + 'affects' + A list of package names. + + 'summary' + Arbitrary text. + + Example. Get the status of bug number #10 from GNU BTS: + + (let ((debbugs-port "gnu.org")) + (debbugs-get-status 10)) + => + (((source . "unknown") (found_versions) (done) (blocks) + (date . 1203606305.0) (fixed) (fixed_versions) (mergedwith) + (found) (unarchived) (blockedby) (keywords) (summary) + (msgid . "<87zltuz7eh.fsf@freemail.hu>") (id . 10) + (forwarded) (severity . "wishlist") + (owner . "Magnus Henoch <*****@freemail.hu>") + (log_modified . 1310061242.0) (location . "db-h") + (subject . "url-gw should support HTTP CONNECT proxies") + (originator . "Magnus Henoch <*****@freemail.hu>") + (last_modified . 1310061242.0) (pending . "pending") (affects) + (archived) (tags) (fixed_date) (package "emacs") (found_date) + (bug_num . 10))) + + -- Function: debbugs-get-attribute bug-or-message attribute + General accessor that returns the value of key ATTRIBUTE. + BUG-OR-MESSAGE must be a list element returned by either + 'debbugs-get-status' or 'debbugs-get-bug-log' (*note Requesting + messages::). + + Example. Return the originator of the last submitted bug report: + + (let ((debbags-port "gnu.org")) + (debbugs-get-attribute + (car (apply 'debbugs-get-status (debbugs-newest-bugs 1))) + 'originator)) + => "Jack Daniels " + + +File: debbugs.info, Node: Requesting messages, Next: Requesting user tags, Prev: Requesting bugs statuses, Up: Top + +5 Requesting messages +********************* + + -- Function: debbugs-get-bug-log bug-number + Returns a list of messages related to BUG-NUMBER. Every message is + an association list with the following attributes: + + 'msg_num' + The number of the message inside the bug log. The numbers are + ascending, newer messages have a higher number. + 'header' + The header lines from the E-mail messages, as arrived at the + bug tracker. + 'body' + The message body. + 'attachments' + A list of possible attachments, or 'nil'. Not implemented yet + server side. + + -- Function: debbugs-get-message-numbers messages + Returns the message numbers of MESSAGES. MESSAGES must be the + result of a 'debbugs-get-bug-log' call. + + Example. Get message numbers from bug report #456789 log from + Debian BTS: + + (let ((debbugs-port "debian.org")) + (debbugs-get-message-numbers (debbugs-get-bug-log 456789))) + => (5 10 12) + + -- Function: debbugs-get-message messages message-number + Returns the message MESSAGE-NUMBER of MESSAGES. MESSAGES must be + the result of a 'debbugs-get-bug-log' call. The returned message + is a list of strings. The first element are the header lines of + the message, the second element is the body of the message. + Further elements of the list, if any, are attachments of the + message. If there is no message with MESSAGE-NUMBER, the function + returns 'nil'. + + Example: Return the first message of the last submitted bug report + to GNU BTS: + + (let* ((debbugs-port "gnu.org") + (messages (apply 'debbugs-get-bug-log + (debbugs-newest-bugs 1)))) + (debbugs-get-message + messages + (car (debbugs-get-message-numbers messages)))) + + -- Function: debbugs-get-mbox bug-number mbox-type &optional filename + Download mbox with all messages from bug report BUG-NUMBER. + MBOX-TYPE specifies a type of mbox and can be one of the following + symbols: + + 'mboxfolder' + Download mbox folder, i.e. mbox with messages as they arrived + at the Debbugs server. + + 'mboxmaint' + Download maintainer's mbox, i.e. mbox with messages as they + are resent from the Debbugs server. + + 'mboxstat' + 'mboxstatus' + Download status mbox. The use of either symbol depends on the + actual Debbugs server configuration. For '"gnu.org"', use the + former; for '"debian.org' - the latter. + + FILENAME, if non-'nil', is the name of the file to store mbox. If + FILENAME is 'nil', the downloaded mbox is inserted into the current + buffer. + + Note, that mbox downloading will work only if the ':bugreport-url' + field of the 'debbugs-servers' variable is specified (*note + Configuration::). + + +File: debbugs.info, Node: Requesting user tags, Prev: Requesting messages, Up: Top + +6 Requesting user tags +********************** + +A user tag is a string, a user has assigned to one or several bugs. The +user is identified by an email address. The port '"gnu.org"' uses also +package names as user identification. + + -- Function: debbugs-get-usertag &rest query + Return a list of bug numbers which match QUERY. + + QUERY is a sequence of keyword-value pairs where the values are + strings, i.e. :KEYWORD "VALUE" [:KEYWORD "VALUE"]* + + Valid keywords are: + + ':user' + The value is the name of the package a bug belongs to, like + '"emacs"', '"coreutils"', or '"tramp"'. It can also be an + email address of a user who has applied a user tag. The + special email address '"me"' is used as pattern, replaced with + 'user-mail-address'. There must be at least one such entry; + it is recommended to have exactly one. + + ':tag' + A string applied as user tag. Often, it is a subproduct + identification, like '"cedet"' or '"tramp"' for the package + '"emacs"'. + + If there is no ':tag' entry, no bug numbers will be returned but a + list of existing user tags for ':user'. + + Example. Get all user tags for the package '"emacs"': + + (let ((debbugs-port "gnu.org")) + (debbugs-get-usertag :user "emacs")) + => ("www" "solaris" "ls-lisp" "cygwin") + + Get all bugs tagged by package '"emacs"' with '"www"' or + '"cygwin"')): + + (let ((debbugs-port "gnu.org")) + (debbugs-get-usertag :user "emacs" :tag "www" :tag "cygwin")) + => (807 1223 5637) + + + +Tag Table: +Node: Top1089 +Node: Installation3042 +Node: Configuration4141 +Node: Requesting bug numbers6047 +Node: Requesting bugs statuses11275 +Node: Requesting messages15326 +Node: Requesting user tags18342 + +End Tag Table diff --git a/packages/debbugs/dir b/packages/debbugs/dir new file mode 100644 index 000000000..d84162759 --- /dev/null +++ b/packages/debbugs/dir @@ -0,0 +1,23 @@ +-*- Text -*- +This is the file .../info/dir, which contains the topmost node of the +Info hierarchy. The first time you invoke Info you start off +looking at that node, which is (dir)Top. + +File: dir Node: Top This is the top of the INFO tree + +The Info Directory +****************** + + The Info Directory is the top-level menu of major Info topics. + Type "d" in Info to return to the Info Directory. Type "q" to exit Info. + Type "?" for a list of Info commands, or "h" to visit an Info tutorial. + Type "m" to choose a menu item--for instance, + "mEmacs" visits the Emacs manual. + In Emacs Info, you can click mouse button 2 on a menu item + or cross reference to follow it to its target. + +* Menu: Each line that starts with a * is a topic you can select with "m". + +Emacs +* Debbugs: (debbugs). A library for communication with Debbugs. +* Debbugs UG: (debbugs-ug). Debbugs User Interface in Emacs. -- 2.39.2