]> code.delx.au - gnu-emacs-elpa/blobdiff - packages/debbugs/debbugs-ug.info
Release debbugs 0.9.6.
[gnu-emacs-elpa] / packages / debbugs / debbugs-ug.info
index 91a01b0d012a94a15036563b9e7f47b293adbeba..11738e30deea2619b291c2fd3e2a2dd33ec68635 100644 (file)
@@ -1,4 +1,4 @@
-This is debbugs-ug.info, produced by makeinfo version 6.0 from
+This is debbugs-ug.info, produced by makeinfo version 6.1 from
 debbugs-ug.texi.
 
 Copyright (C) 2015-2016 Free Software Foundation, Inc.
@@ -35,10 +35,10 @@ the Debian project but currently 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.
+composed letters to the particular email 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
@@ -80,10 +80,10 @@ prefix.
 
      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.
+     a list of TODO items in 'org-mode'.  In order not to stress the
+     GNU Debbugs server, the bugs are retrieved in chunks of 500 bugs.
+     However, the bug report buffer shows all retrieved bugs then, in
+     reverse bug number order.
 
      SEVERITIES is a list of strings which filter for the severities
      of the bugs to be retrieved.  Valid severities are '"serious"',
@@ -103,7 +103,11 @@ prefix.
      on the GNU Debbugs server.
 
      SUPPRESS shall also distinct between 'nil' and non-'nil'.  When
-     non-'nil', closed bugs are suppressed from the results.
+     non-'nil', closed bugs are suppressed from being retrieved from
+     the Debbugs server.  Which bugs are regarded as suppressed is
+     configured in the customer option 'debbugs-gnu-suppress-bugs'.
+     Per default, bugs marked as '"done"' are suppressed from being
+     retrieved.
 
      When SEVERITIES contains the severity '"tagged"', TAGS is
      consulted in order to restrict the result on bugs which are
@@ -121,12 +125,6 @@ prefix.
      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
@@ -138,28 +136,38 @@ prefix.
 
      *note Layout:: for the presentation of the results.
 
+ -- Command: debbugs-gnu-patches
+ -- Command: debbugs-org-patches
+
+     The commands 'debbugs-gnu-patches' and 'debbugs-org-patches' show
+     all bugs tagged with '"patch"'.  This is useful for bug triages.
+
+     *note Layout:: for the presentation of the results.
+
 \1f
 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
+The GNU Debbugs server allows text search in the database in the
+messages submitted to the bugs.  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.
+     '"search phrase"' for the 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.  Only complete words, contained in a
+     message body, are searched for.
 
      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"
+     "[BW] euro" matches words which begin with "euro".  "[EW] sphere"
      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)
@@ -184,8 +192,8 @@ uses a HyperEstraier based search engine
      'tags'
           A comma-separated list of defined user tags.
 
-     'submitter'
-          The address of the bug submitter.
+     'author'
+          The email address of a message originator.
 
      'date'
           A time period the bug has been in which the bug has been
@@ -195,8 +203,8 @@ uses a HyperEstraier based search engine
           Word(s) the subject of the bug report contains.
 
      'status'
-          The status of the bug report.  Valid values are "done",
-          "forwarded" and "open".
+          The status of the bug report.  Valid values are "pending",
+          "forwarded", "fixed" and "done".
 
      It is also possible to apply these commands with an empty search
      phrase.  In this case, the GNU Debbugs server is searched only
@@ -216,10 +224,11 @@ uses a HyperEstraier based search engine
           this is the same as the status mentioned above.
 
      'owner'
+     'submitter'
      'maint'
      'correspondent'
-          The email address of the bug's owner, maintainer, or
-          correspondent (somebody who has participated in bug
+          The email address of the bug's owner, submitter, maintainer,
+          or correspondent (somebody who has participated in bug
           messages).
 
      'log_modified'
@@ -249,7 +258,9 @@ uses a HyperEstraier based search engine
      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.
+     after the attribute name.  Note, that client side filters perform
+     badly, because they could be applied only after all bugs have
+     been downloaded.
 
    ---------- Footnotes ----------
 
@@ -285,14 +296,8 @@ File: debbugs-ug.info,  Node: Tabulated Lists,  Next: TODO Items,  Up: Layout
 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.
+subject).  Per default the bugs are sorted descending by 'Id'; this
+could be changed by clicking in the headline.
 
    Different foreground colours present further information on the bug
 report.  If the bug number uses a red colour ('debbugs-gnu-tagged'),
@@ -330,7 +335,9 @@ This enables the following key strokes:
                Restore the full list again after narrowing.
                
 'g'            'debbugs-gnu-rescan'
-               Reload all bugs from the GNU Debbugs server.
+               Reload all bugs.  With a prefix argument 'C-u', the
+               bug status cache is disabled, and all bug reports are
+               retrieved from the GNU Debbugs server.
                
 'B'            'debbugs-gnu-show-blocking-reports'
 'b'            'debbugs-gnu-show-blocked-by-reports'
@@ -351,6 +358,9 @@ This enables the following key strokes:
                *note Control Messages::.
                
 
+   The user option 'debbugs-gnu-suppress-closed' controls, whether
+closed bugs are shown in the initial list.
+
    The user option 'debbugs-gnu-mail-backend' controls the
 presentation of email messages produced by typing '<RET>' or by
 clicking the mouse on a bug: if its value is 'gnus', the default, a
@@ -367,15 +377,10 @@ 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'.
+   The bug report buffers have enabled the minor 'debbugs-org-mode'.
 This enables the following key strokes:
 
 '<TAB>'     'org-cycle'
@@ -456,13 +461,6 @@ The strings show the exact format of the control messages.
 
      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"
@@ -482,6 +480,18 @@ The strings show the exact format of the control messages.
 'reopen'
      "reopen 12345"
 
+'retitle'
+     "retitle 12345 TITLE"
+
+     The new bug title is read interactively.
+
+'serious'
+'important'
+'normal'
+'minor'
+'wishlist'
+     "severity 12345 serious|important|normal|minor|wishlist"
+
 'unarchive'
      "unarchive 12345"
 
@@ -529,11 +539,13 @@ Command Index
 
 * debbugs-browse-mode:                   Minor Mode.         (line 12)
 * debbugs-gnu:                           Retrieving Bugs.    (line 15)
-* debbugs-gnu-bugs:                      Retrieving Bugs.    (line 71)
-* debbugs-gnu-search:                    Searching Bugs.     (line 10)
+* debbugs-gnu-bugs:                      Retrieving Bugs.    (line 69)
+* debbugs-gnu-patches:                   Retrieving Bugs.    (line 78)
+* debbugs-gnu-search:                    Searching Bugs.     (line 11)
 * debbugs-org:                           Retrieving Bugs.    (line 17)
-* debbugs-org-bugs:                      Retrieving Bugs.    (line 72)
-* debbugs-org-search:                    Searching Bugs.     (line 11)
+* debbugs-org-bugs:                      Retrieving Bugs.    (line 70)
+* debbugs-org-patches:                   Retrieving Bugs.    (line 79)
+* debbugs-org-search:                    Searching Bugs.     (line 12)
 
 \1f
 File: debbugs-ug.info,  Node: Variable Index,  Next: Key Index,  Prev: Command Index,  Up: Top
@@ -547,10 +559,11 @@ Variable Index
 * debbugs-browse-function:               Minor Mode.         (line 12)
 * debbugs-gnu-all-packages:              Retrieving Bugs.    (line 36)
 * debbugs-gnu-all-severities:            Retrieving Bugs.    (line 27)
-* debbugs-gnu-default-hits-per-page:     Retrieving Bugs.    (line 63)
-* debbugs-gnu-default-packages:          Retrieving Bugs.    (line 59)
-* debbugs-gnu-default-severities:        Retrieving Bugs.    (line 59)
-* debbugs-gnu-mail-backend:              Tabulated Lists.    (line 75)
+* debbugs-gnu-default-packages:          Retrieving Bugs.    (line 63)
+* debbugs-gnu-default-severities:        Retrieving Bugs.    (line 63)
+* debbugs-gnu-default-suppress-bugs:     Retrieving Bugs.    (line 44)
+* debbugs-gnu-mail-backend:              Tabulated Lists.    (line 74)
+* debbugs-gnu-suppress-closed:           Tabulated Lists.    (line 71)
 
 \1f
 File: debbugs-ug.info,  Node: Key Index,  Prev: Variable Index,  Up: Top
@@ -561,40 +574,40 @@ Key Index
 \0\b[index\0\b]
 * Menu:
 
-* '/':                                   Tabulated Lists.    (line 42)
-* 'B':                                   Tabulated Lists.    (line 56)
-* 'b':                                   Tabulated Lists.    (line 57)
-* 'C':                                   Tabulated Lists.    (line 70)
-* '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 39)
-* 'g':                                   Tabulated Lists.    (line 53)
-* '<mouse-1>':                           Tabulated Lists.    (line 36)
-* '<mouse-2>':                           Tabulated Lists.    (line 37)
-* 'R':                                   Tabulated Lists.    (line 46)
-* '<RET>':                               Tabulated Lists.    (line 35)
-* 's':                                   Tabulated Lists.    (line 61)
-* 't':                                   Tabulated Lists.    (line 64)
-* '<TAB>':                               TODO Items.         (line 21)
-* 'w':                                   Tabulated Lists.    (line 50)
-* 'x':                                   Tabulated Lists.    (line 67)
+* /:                                     Tabulated Lists.    (line 36)
+* B:                                     Tabulated Lists.    (line 52)
+* b:                                     Tabulated Lists.    (line 53)
+* C:                                     Tabulated Lists.    (line 66)
+* C-c # C:                               TODO Items.         (line 25)
+* C-c # d:                               TODO Items.         (line 19)
+* C-c # t:                               TODO Items.         (line 22)
+* d:                                     Tabulated Lists.    (line 33)
+* g:                                     Tabulated Lists.    (line 47)
+* <mouse-1>:                             Tabulated Lists.    (line 30)
+* <mouse-2>:                             Tabulated Lists.    (line 31)
+* R:                                     Tabulated Lists.    (line 40)
+* <RET>:                                 Tabulated Lists.    (line 29)
+* s:                                     Tabulated Lists.    (line 57)
+* t:                                     Tabulated Lists.    (line 60)
+* <TAB>:                                 TODO Items.         (line 16)
+* w:                                     Tabulated Lists.    (line 44)
+* x:                                     Tabulated Lists.    (line 63)
 
 
 \1f
 Tag Table:
 Node: Top\7f1097
-Node: Retrieving Bugs\7f2634
-Node: Searching Bugs\7f6165
-Ref: Searching Bugs-Footnote-1\7f10044
-Ref: Searching Bugs-Footnote-2\7f10132
-Node: Layout\7f10223
-Node: Tabulated Lists\7f10698
-Node: TODO Items\7f14062
-Node: Control Messages\7f15327
-Node: Minor Mode\7f17638
-Node: Command Index\7f18577
-Node: Variable Index\7f19224
-Node: Key Index\7f19872
+Node: Retrieving Bugs\7f2635
+Node: Searching Bugs\7f6362
+Ref: Searching Bugs-Footnote-1\7f10520
+Ref: Searching Bugs-Footnote-2\7f10608
+Node: Layout\7f10699
+Node: Tabulated Lists\7f11174
+Node: TODO Items\7f14532
+Node: Control Messages\7f15579
+Node: Minor Mode\7f17975
+Node: Command Index\7f18914
+Node: Variable Index\7f19703
+Node: Key Index\7f20422
 \1f
 End Tag Table