branch: master commit b11eef7c968e4dd66be228a7d9ad3a76544b4e0b Author: Michael Albinus <michael.albi...@gmx.de> Commit: Michael Albinus <michael.albi...@gmx.de>
Add mail command index in debbugs * packages/debbugs/debbugs-ug.texi (Top): Add Mail Command Index. * packages/debbugs/debbugs.texi (Requesting bug numbers) (Searching bugs): Use @uref{}. * packages/debbugs/instructions.texi: New file. --- packages/debbugs/debbugs-ug.info | 332 +++++++++++++++++++++++++++++++++++-- packages/debbugs/debbugs-ug.texi | 6 + packages/debbugs/debbugs.texi | 4 +- packages/debbugs/instructions.texi | 302 +++++++++++++++++++++++++++++++++ 4 files changed, 628 insertions(+), 16 deletions(-) diff --git a/packages/debbugs/debbugs-ug.info b/packages/debbugs/debbugs-ug.info index 7e3901d..19d7040 100644 --- a/packages/debbugs/debbugs-ug.info +++ b/packages/debbugs/debbugs-ug.info @@ -57,6 +57,7 @@ Org Mode: (org)Top.). As backend they use the 'debbugs' Emacs library * Command Index:: Debbugs commands. * Variable Index:: User options and variables. * Key Index:: Keyboard strokes on bug report buffers. +* Mail Command Index:: Debbugs control mailserver commands. File: debbugs-ug.info, Node: Retrieving Bugs, Next: Searching Bugs, Prev: Top, Up: Top @@ -641,7 +642,7 @@ Variable Index * debbugs-org-severity-priority: TODO Items. (line 10) -File: debbugs-ug.info, Node: Key Index, Prev: Variable Index, Up: Top +File: debbugs-ug.info, Node: Key Index, Next: Mail Command Index, Prev: Variable Index, Up: Top Key Index ********* @@ -670,22 +671,325 @@ Key Index * w: Tabulated Lists. (line 49) * x: Tabulated Lists. (line 68) + +File: debbugs-ug.info, Node: Mail Command Index, Prev: Key Index, Up: Top + +Debbugs control mailserver commands +*********************************** + +'reassign bugnumber package [ version ]' + Records that bug #bugnumber is a bug in package. This can be + used to set the package if the user forgot the pseudo-header, or + to change an earlier assignment. No notifications are sent to + anyone (other than the usual information in the processing + transcript). + + If you supply a version, the bug tracking system will note that + the bug affects that version of the newly-assigned package. + +'reopen bugnumber [ originator-address | = | ! ]' + Reopens #bugnumber if it is closed. + + By default, or if you specify =, the original submitter is still + as the originator of the report, so that they will get the ack + when it is closed again. + + If you supply an originator-address the originator will be set to + the address you supply. If you wish to become the new originator + of the reopened report you can use the ! shorthand or specify + your own email address. + + It is usually a good idea to tell the person who is about to be + recorded as the originator that you're reopening the report, so + that they will know to expect the ack which they'll get when it + is closed again. + + If the bug is not closed then reopen won't do anything, not even + change the originator. To change the originator of an open bug + report, use the submitter command; note that this will inform the + original submitter of the change. + + If the bug was recorded as being closed in a particular version + of a package but recurred in a later version, it is better to use + the found command instead. + +'found bugnumber [ version ]' + Record that #bugnumber has been encountered in the given version + of the package to which it is assigned. + + The bug tracking system uses this information, in conjunction + with fixed versions recorded when closing bugs, to display lists + of bugs open in various versions of each package. It considers a + bug to be open when it has no fixed version, or when it has been + found more recently than it has been fixed. + + If no version is given, then the list of fixed versions for the + bug is cleared. This is identical to the behaviour of reopen. + + This command will only cause a bug to be marked as not done if no + version is specified, or if the version being marked found is + equal to the version which was last marked fixed. (If you are + certain that you want the bug marked as not done, use reopen in + conjunction with found. + + This command was introduced in preference to reopen because it + was difficult to add a version to that command's syntax without + suffering ambiguity. + +'notfound bugnumber version' + Remove the record that #bugnumber was encountered in the given + version of the package to which it is assigned. + + This differs from closing the bug at that version in that the bug + is not listed as fixed in that version either; no information + about that version will be known. It is intended for fixing + mistakes in the record of when a bug was found. + +'submitter bugnumber originator-address | !' + Changes the originator of #bugnumber to originator-address. + + If you wish to become the new originator of the report you can + use the ! shorthand or specify your own email address. + + While the reopen command changes the originator of other bugs + merged with the one being reopened, submitter does not affect + merged bugs. + +'forwarded bugnumber address' + Notes that bugnumber has been forwarded to the upstream + maintainer at address. This does not actually forward the + report. This can be used to change an existing incorrect + forwarded-to address, or to record a new one for a bug that + wasn't previously noted as having been forwarded. + +'notforwarded bugnumber' + Forgets any idea that bugnumber has been forwarded to any + upstream maintainer. If the bug was not recorded as having been + forwarded then this will do nothing. + +'retitle bugnumber new-title' + Changes the title of a bug report to that specified (the default + is the Subject mail header from the original report). + + Unlike most of the other bug-manipulation commands when used on + one of a set of merged reports this will change the title of only + the individual bug requested, and not all those with which it is + merged. + +'severity bugnumber severity' + Set the severity level for bug report #bugnumber to severity. No + notification is sent to the user who reported the bug. + + For their meanings please consult the general developers' + documentation for the bug system. + +'clone bugnumber NewID [ new IDs ... ]' + The clone control command allows you to duplicate a bug report. + It is useful in the case where a single report actually indicates + that multiple distinct bugs have occurred. "New IDs" are + negative numbers, separated by spaces, which may be used in + subsequent control commands to refer to the newly duplicated + bugs. A new report is generated for each new ID. + + Example usage: + + clone 12345 -1 -2 + reassign -1 foo + retitle -1 foo: foo sucks + reassign -2 bar + retitle -2 bar: bar sucks when used with foo + severity -2 wishlist + clone 123456 -3 + reassign -3 foo + retitle -3 foo: foo sucks + merge -1 -3 + +'merge bugnumber bugnumber ...' + Merges two or more bug reports. When reports are merged opening, + closing, marking or unmarking as forwarded and reassigning any of + the bugs to a new package will have an identical effect on all of + the merged reports. + + Before bugs can be merged they must be in exactly the same state: + either all open or all closed, with the same forwarded-to + upstream author address or all not marked as forwarded, all + assigned to the same package or package(s) (an exact string + comparison is done on the package to which the bug is assigned), + and all of the same severity. If they don't start out in the + same state you should use reassign, reopen and so forth to make + sure that they are before using merge. Titles are not required + to match, and will not be affected by the merge. + + If any of the bugs listed in a merge command is already merged + with another bug then all the reports merged with any of the ones + listed will all be merged together. Merger is like equality: it + is reflexive, transitive and symmetric. + + Merging reports causes a note to appear on each report's logs; on + the WWW pages this includes links to the other bugs. + + Merged reports are all expired simultaneously, and only when all + of the reports each separately meet the criteria for expiry. + +'forcemerge bugnumber bugnumber ...' + Forcibly merges two or more bug reports. The first bug is chosen + as the master bug, and its seetings are assigned to the bugs + listed next in the command. See the text above for a description + of what merging means. + +'unmerge bugnumber' + Disconnects a bug report from any other reports with which it may + have been merged. If the report listed is merged with several + others then they are all left merged with each other; only their + associations with the bug explicitly named are removed. + + If many bug reports are merged and you wish to split them into + two separate groups of merged reports you must unmerge each + report in one of the new groups separately and then merge them + into the required new group. + + You can only unmerge one report with each unmerge command; if you + want to disconnect more than one bug simply include several + unmerge commands in your message. + +'tags bugnumber [ + | - | = ] tag [ tag ... ]' + Sets tags for the bug report #bugnumber. No notification is sent + to the user who reported the bug. Setting the action to + means + to add each given tag, - means to remove each given tag, and = + means to ignore the current tags and set them afresh to the list + provided. The default action is adding. + + Example usage: + + # same as 'tags 123456 + patch' + tags 123456 patch + + # same as 'tags 123456 + help security' + tags 123456 help security + + # add 'fixed' and 'pending' tags + tags 123456 + fixed pending + + # remove 'unreproducible' tag + tags 123456 - unreproducible + + # set tags to exactly 'moreinfo' and 'unreproducible' + tags 123456 = moreinfo unreproducible + + Available tags currently include patch, wontfix, moreinfo, + unreproducible, help, pending, fixed, security, upstream, potato, + woody, sarge, sid and experimental. + + For their meanings please consult the general developers' + documentation for the bug system. + +'block bugnumber by|with bug [ bug ... ]' +'unblock bugnumber by|with bug [ bug ... ]' + Use to note that one bug blocks another bug from being fixed. + The first listed bug is the one being blocked, and it is followed + by the bug or bugs that are blocking it. Use unblock to unblock + a bug. + + Example usage: + + # indicates that 7890 cannot be fixed until 123456 is fixed + block 7890 by 123456 + # indicates that 7890 can be fixed before 123456 after all + unblock 7890 by 123456 + +'close bugnumber [ fixed-version ] (deprecated)' + Close bug report #bugnumber. + + A notification is sent to the user who reported the bug, but (in + contrast to mailing bugnumber-done) the text of the mail which + caused the bug to be closed is not included in that notification. + The maintainer who closes a report should ensure, probably by + sending a separate message, that the user who reported the bug + knows why it is being closed. The use of this command is + therefore deprecated. + + If you supply a fixed-version, the bug tracking system will note + that the bug was fixed in that version of the package. + +'package [ packagename ... ]' + Limits the following commands so that they will only apply to + bugs filed against the listed packages. You can list one or more + packages. If you don't list any packages, the following commands + will apply to all bugs. You're encouraged to use this as a + safety feature in case you accidentally use the wrong bug + numbers. + + Example usage: + + package foo + reassign 123456 bar 1.0-1 + + package bar + retitle 123456 bar: bar sucks + severity 123456 normal + + package + severity 234567 wishlist + +'owner bugnumber address | !' + Sets address to be the "owner" of #bugnumber. The owner of a bug + claims responsibility for fixing it. This is useful to share out + work in cases where a package has a team of maintainers. + + If you wish to become the owner of the bug yourself, you can use + the ! shorthand or specify your own email address. + +'noowner bugnumber' + Forgets any idea that the bug has an owner other than the usual + maintainer. If the bug had no owner recorded then this will do + nothing. + +'archive bugnumber' + Archives a bug that was previously archived if the bug fulfills + the requirements for archival, ignoring time. + +'unarchive bugnumber' + Unarchives a bug that was previously archived. Unarchival should + generally be coupled with reopen and found/fixed as approprite. + Bugs that have been unarchived can be archived using archive + assuming the non-time based archival requirements are met. + +'#...' + One-line comment. The # must be at the start of the line. The + text of comments will be included in the acknowledgement sent to + the sender and to affected maintainers, so you can use this to + document the reasons for your commands. + +'quit' +'stop' +'thank' +'thanks' +'thankyou' +'thank you' +'--' + On a line by itself, in any case, possibly followed by + whitespace, tells the control server to stop processing the + message; the remainder of the message can include explanations, + signatures or anything else, none of it will be detected by the + control server. + Tag Table: Node: Top1097 -Node: Retrieving Bugs2635 -Node: Searching Bugs6868 -Ref: Searching Bugs-Footnote-111181 -Ref: Searching Bugs-Footnote-211269 -Node: Presenting Bugs11360 -Node: Tabulated Lists11936 -Node: TODO Items15611 -Node: Control Messages16667 -Node: Applying Patches19851 -Node: Minor Mode21217 -Node: Command Index22273 -Node: Variable Index23062 -Node: Key Index24136 +Node: Retrieving Bugs2704 +Node: Searching Bugs6937 +Ref: Searching Bugs-Footnote-111250 +Ref: Searching Bugs-Footnote-211338 +Node: Presenting Bugs11429 +Node: Tabulated Lists12005 +Node: TODO Items15680 +Node: Control Messages16736 +Node: Applying Patches19920 +Node: Minor Mode21286 +Node: Command Index22342 +Node: Variable Index23131 +Node: Key Index24205 +Node: Mail Command Index25771 End Tag Table diff --git a/packages/debbugs/debbugs-ug.texi b/packages/debbugs/debbugs-ug.texi index b4d8885..f3623dd 100644 --- a/packages/debbugs/debbugs-ug.texi +++ b/packages/debbugs/debbugs-ug.texi @@ -68,6 +68,7 @@ Programmer's Manual, debbugs}). * Command Index:: Debbugs commands. * Variable Index:: User options and variables. * Key Index:: Keyboard strokes on bug report buffers. +* Mail Command Index:: Debbugs control mailserver commands. @end menu @@ -684,6 +685,11 @@ buffer, when @code{debbugs-browse-mode} is enabled. See user option @unnumbered Key Index @printindex ky + +@node Mail Command Index +@unnumbered Debbugs control mailserver commands +@include instructions.texi + @bye @c Local Variables: diff --git a/packages/debbugs/debbugs.texi b/packages/debbugs/debbugs.texi index 9b01512..898fdb6 100644 --- a/packages/debbugs/debbugs.texi +++ b/packages/debbugs/debbugs.texi @@ -236,7 +236,7 @@ GNU port: @code{"fixed"}, @code{"notabug"}, @code{"wontfix"}, @code{"unreproducible"}, @code{"moreinfo"}, @code{"patch"}, @code{"pending"}, @code{"help"}, @code{"security"}, @code{"confirmed"}, @code{"easy"}. See -@url{https://debbugs.gnu.org/Developer.html#tags} for the actual list +@uref{https://debbugs.gnu.org/Developer.html#tags} for the actual list of tags. @item :owner @@ -466,7 +466,7 @@ values are strings or numbers, i.e.@: @var{:keyword} @var{value} Every sublist of the @var{query} forms a hyperestraier condition. A detailed description of hyperestraier conditions can be found at @c https does not work. -@url{http://fallabs.com/hyperestraier/uguide-en.html#searchcond}. +@uref{http://fallabs.com/hyperestraier/uguide-en.html#searchcond}. The following conditions are possible: diff --git a/packages/debbugs/instructions.texi b/packages/debbugs/instructions.texi new file mode 100644 index 0000000..e3c5f29 --- /dev/null +++ b/packages/debbugs/instructions.texi @@ -0,0 +1,302 @@ +@table @samp +@item reassign bugnumber package [ version ] +Records that bug #bugnumber is a bug in package. This can be used +to set the package if the user forgot the pseudo-header, or to +change an earlier assignment. No notifications are sent to anyone +(other than the usual information in the processing transcript). + +If you supply a version, the bug tracking system will note that +the bug affects that version of the newly-assigned package. + +@item reopen bugnumber [ originator-address | = | ! ] +Reopens #bugnumber if it is closed. + +By default, or if you specify =, the original submitter is still +as the originator of the report, so that they will get the ack +when it is closed again. + +If you supply an originator-address the originator will be set to +the address you supply. If you wish to become the new originator +of the reopened report you can use the ! shorthand or specify your +own email address. + +It is usually a good idea to tell the person who is about to be +recorded as the originator that you're reopening the report, so +that they will know to expect the ack which they'll get when it is +closed again. + +If the bug is not closed then reopen won't do anything, not even +change the originator. To change the originator of an open bug +report, use the submitter command; note that this will inform the +original submitter of the change. + +If the bug was recorded as being closed in a particular version of +a package but recurred in a later version, it is better to use the +found command instead. + +@item found bugnumber [ version ] +Record that #bugnumber has been encountered in the given version +of the package to which it is assigned. + +The bug tracking system uses this information, in conjunction with +fixed versions recorded when closing bugs, to display lists of +bugs open in various versions of each package. It considers a bug +to be open when it has no fixed version, or when it has been found +more recently than it has been fixed. + +If no version is given, then the list of fixed versions for the +bug is cleared. This is identical to the behaviour of reopen. + +This command will only cause a bug to be marked as not done if no +version is specified, or if the version being marked found is +equal to the version which was last marked fixed. (If you are +certain that you want the bug marked as not done, use reopen in +conjunction with found. + +This command was introduced in preference to reopen because it was +difficult to add a version to that command's syntax without +suffering ambiguity. + +@item notfound bugnumber version +Remove the record that #bugnumber was encountered in the given +version of the package to which it is assigned. + +This differs from closing the bug at that version in that the bug +is not listed as fixed in that version either; no information +about that version will be known. It is intended for fixing +mistakes in the record of when a bug was found. + +@item submitter bugnumber originator-address | ! +Changes the originator of #bugnumber to originator-address. + +If you wish to become the new originator of the report you can use +the ! shorthand or specify your own email address. + +While the reopen command changes the originator of other bugs +merged with the one being reopened, submitter does not affect +merged bugs. + +@item forwarded bugnumber address +Notes that bugnumber has been forwarded to the upstream maintainer +at address. This does not actually forward the report. This can be +used to change an existing incorrect forwarded-to address, or to +record a new one for a bug that wasn't previously noted as having +been forwarded. + +@item notforwarded bugnumber +Forgets any idea that bugnumber has been forwarded to any upstream +maintainer. If the bug was not recorded as having been forwarded +then this will do nothing. + +@item retitle bugnumber new-title +Changes the title of a bug report to that specified (the default +is the Subject mail header from the original report). + +Unlike most of the other bug-manipulation commands when used on +one of a set of merged reports this will change the title of only +the individual bug requested, and not all those with which it is +merged. + +@item severity bugnumber severity +Set the severity level for bug report #bugnumber to severity. No +notification is sent to the user who reported the bug. + +For their meanings please consult the general developers' +documentation for the bug system. + +@item clone bugnumber NewID [ new IDs @dots{} ] +The clone control command allows you to duplicate a bug report. It +is useful in the case where a single report actually indicates +that multiple distinct bugs have occurred. "New IDs" are negative +numbers, separated by spaces, which may be used in subsequent +control commands to refer to the newly duplicated bugs. A new +report is generated for each new ID. + +Example usage: + +@example +clone 12345 -1 -2 +reassign -1 foo +retitle -1 foo: foo sucks +reassign -2 bar +retitle -2 bar: bar sucks when used with foo +severity -2 wishlist +clone 123456 -3 +reassign -3 foo +retitle -3 foo: foo sucks +merge -1 -3 +@end example + +@item merge bugnumber bugnumber @dots{} + Merges two or more bug reports. When reports are merged opening, + closing, marking or unmarking as forwarded and reassigning any of + the bugs to a new package will have an identical effect on all of + the merged reports. + + Before bugs can be merged they must be in exactly the same state: +either all open or all closed, with the same forwarded-to upstream +author address or all not marked as forwarded, all assigned to the +same package or package(s) (an exact string comparison is done on +the package to which the bug is assigned), and all of the same +severity. If they don't start out in the same state you should use +reassign, reopen and so forth to make sure that they are before +using merge. Titles are not required to match, and will not be +affected by the merge. + +If any of the bugs listed in a merge command is already merged +with another bug then all the reports merged with any of the ones +listed will all be merged together. Merger is like equality: it is +reflexive, transitive and symmetric. + +Merging reports causes a note to appear on each report's logs; on +the WWW pages this includes links to the other bugs. + +Merged reports are all expired simultaneously, and only when all +of the reports each separately meet the criteria for expiry. + +@item forcemerge bugnumber bugnumber @dots{} +Forcibly merges two or more bug reports. The first bug is chosen +as the master bug, and its seetings are assigned to the bugs +listed next in the command. See the text above for a description +of what merging means. + +@item unmerge bugnumber +Disconnects a bug report from any other reports with which it may +have been merged. If the report listed is merged with several +others then they are all left merged with each other; only their +associations with the bug explicitly named are removed. + +If many bug reports are merged and you wish to split them into two +separate groups of merged reports you must unmerge each report in +one of the new groups separately and then merge them into the +required new group. + +You can only unmerge one report with each unmerge command; if you +want to disconnect more than one bug simply include several +unmerge commands in your message. + +@item tags bugnumber [ + | - | = ] tag [ tag @dots{} ] +Sets tags for the bug report #bugnumber. No notification is sent +to the user who reported the bug. Setting the action to + means to +add each given tag, - means to remove each given tag, and = means +to ignore the current tags and set them afresh to the list +provided. The default action is adding. + +Example usage: + +@example +# same as 'tags 123456 + patch' +tags 123456 patch + +# same as 'tags 123456 + help security' +tags 123456 help security + +# add 'fixed' and 'pending' tags +tags 123456 + fixed pending + +# remove 'unreproducible' tag +tags 123456 - unreproducible + +# set tags to exactly 'moreinfo' and 'unreproducible' +tags 123456 = moreinfo unreproducible +@end example + +Available tags currently include patch, wontfix, moreinfo, +unreproducible, help, pending, fixed, security, upstream, potato, +woody, sarge, sid and experimental. + +For their meanings please consult the general developers' +documentation for the bug system. + +@item block bugnumber by|with bug [ bug @dots{} ] +@itemx unblock bugnumber by|with bug [ bug @dots{} ] +Use to note that one bug blocks another bug from being fixed. The +first listed bug is the one being blocked, and it is followed by +the bug or bugs that are blocking it. Use unblock to unblock a +bug. + +Example usage: + +@example +# indicates that 7890 cannot be fixed until 123456 is fixed +block 7890 by 123456 +# indicates that 7890 can be fixed before 123456 after all +unblock 7890 by 123456 +@end example + +@item close bugnumber [ fixed-version ] (deprecated) +Close bug report #bugnumber. + +A notification is sent to the user who reported the bug, but (in +contrast to mailing bugnumber-done) the text of the mail which +caused the bug to be closed is not included in that notification. +The maintainer who closes a report should ensure, probably by +sending a separate message, that the user who reported the bug +knows why it is being closed. The use of this command is therefore +deprecated. + +If you supply a fixed-version, the bug tracking system will note +that the bug was fixed in that version of the package. + +@item package [ packagename @dots{} ] +Limits the following commands so that they will only apply to bugs +filed against the listed packages. You can list one or more +packages. If you don't list any packages, the following commands +will apply to all bugs. You're encouraged to use this as a safety +feature in case you accidentally use the wrong bug numbers. + +Example usage: + +@example +package foo +reassign 123456 bar 1.0-1 + +package bar +retitle 123456 bar: bar sucks +severity 123456 normal + +package +severity 234567 wishlist +@end example + +@item owner bugnumber address | ! +Sets address to be the "owner" of #bugnumber. The owner of a bug +claims responsibility for fixing it. This is useful to share out +work in cases where a package has a team of maintainers. + +If you wish to become the owner of the bug yourself, you can use +the ! shorthand or specify your own email address. + +@item noowner bugnumber +Forgets any idea that the bug has an owner other than the usual +maintainer. If the bug had no owner recorded then this will do +nothing. + +@item archive bugnumber + Archives a bug that was previously archived if the bug fulfills + the requirements for archival, ignoring time. + +@item unarchive bugnumber +Unarchives a bug that was previously archived. Unarchival should +generally be coupled with reopen and found/fixed as approprite. +Bugs that have been unarchived can be archived using archive +assuming the non-time based archival requirements are met. + +@item #@dots{} +One-line comment. The # must be at the start of the line. The text +of comments will be included in the acknowledgement sent to the +sender and to affected maintainers, so you can use this to +document the reasons for your commands. + +@item quit +@itemx stop +@itemx thank +@itemx thanks +@itemx thankyou +@itemx thank you +@itemx -- +On a line by itself, in any case, possibly followed by whitespace, +tells the control server to stop processing the message; the +remainder of the message can include explanations, signatures or +anything else, none of it will be detected by the control server. +@end table