doc: Add "Tracking Bugs and Patches" section.

* doc/contributing.texi (Tracking Bugs and Patches): New section.
(Submitting Patches): Refer to it.
* doc/guix.texi: Update copyright line.
* HACKING (Using emacs-debbugs): Remove.
This commit is contained in:
Ludovic Courtès 2020-01-01 16:05:11 +01:00
parent f75243e17e
commit a7bde77d24
No known key found for this signature in database
GPG Key ID: 090B11993D9AEBB5
3 changed files with 57 additions and 16 deletions

View File

@ -63,12 +63,3 @@ after two weeks, and if youre confident, its OK to commit.
That last part is subject to being adjusted, allowing individuals to commit That last part is subject to being adjusted, allowing individuals to commit
directly on non-controversial changes on parts theyre familiar with. directly on non-controversial changes on parts theyre familiar with.
* Using emacs-debbugs
Bug reports and patches are tracked using debbugs. If you are on emacs, you
can use emacs-debbugs.
List all open bug reports on guix-patches with
C-u M-x debbugs-gnu <RET> <RET> guix-patches <RET> n y

View File

@ -26,6 +26,7 @@ choice.
* Packaging Guidelines:: Growing the distribution. * Packaging Guidelines:: Growing the distribution.
* Coding Style:: Hygiene of the contributor. * Coding Style:: Hygiene of the contributor.
* Submitting Patches:: Share your work. * Submitting Patches:: Share your work.
* Tracking Bugs and Patches:: Using Debbugs.
@end menu @end menu
@node Building from Git @node Building from Git
@ -827,12 +828,12 @@ Thus, access to the repository is not strictly necessary. We welcome
contributions in the form of patches as produced by @code{git contributions in the form of patches as produced by @code{git
format-patch} sent to the @email{guix-patches@@gnu.org} mailing list. format-patch} sent to the @email{guix-patches@@gnu.org} mailing list.
This mailing list is backed by a Debbugs instance accessible at This mailing list is backed by a Debbugs instance, which allows us to
@uref{https://bugs.gnu.org/guix-patches}, which allows us to keep track keep track of submissions (@pxref{Tracking Bugs and Patches}). Each
of submissions. Each message sent to that mailing list gets a new message sent to that mailing list gets a new tracking number assigned;
tracking number assigned; people can then follow up on the submission by people can then follow up on the submission by sending email to
sending email to @code{@var{NNN}@@debbugs.gnu.org}, where @var{NNN} is @code{@var{NNN}@@debbugs.gnu.org}, where @var{NNN} is the tracking
the tracking number (@pxref{Sending a Patch Series}). number (@pxref{Sending a Patch Series}).
Please write commit logs in the ChangeLog format (@pxref{Change Logs,,, Please write commit logs in the ChangeLog format (@pxref{Change Logs,,,
standards, GNU Coding Standards}); you can check the commit history for standards, GNU Coding Standards}); you can check the commit history for
@ -1040,3 +1041,52 @@ they are kept together. See
for more information. You can install @command{git send-email} with for more information. You can install @command{git send-email} with
@command{guix install git:send-email}. @command{guix install git:send-email}.
@c Debbugs bug: https://debbugs.gnu.org/db/15/15361.html @c Debbugs bug: https://debbugs.gnu.org/db/15/15361.html
@node Tracking Bugs and Patches
@section Tracking Bugs and Patches
@cindex bug reports, tracking
@cindex patch submissions, tracking
@cindex issue tracking
@cindex Debbugs, issue tracking system
Bug reports and patch submissions are currently tracked using the
Debbugs instance at @uref{https://bugs.gnu.org}. Bug reports are filed
against the @code{guix} ``package'' (in Debbugs parlance), by sending
email to @email{bug-guix@@gnu.org}, while patch submissions are filed
against the @code{guix-patches} package by sending email to
@email{guix-patches@@gnu.org} (@pxref{Submitting Patches}).
A web interface (actually @emph{two} web interfaces!) are available to
browse issues:
@itemize
@item
@url{https://bugs.gnu.org/guix} lists bug reports;
@item
@url{https://bugs.gnu.org/guix-patches} lists patch submissions.
@end itemize
You can also access both of these @i{via} the (nicer)
@url{https://issues.guix.gnu.org} interface@footnote{The web interface
at @url{https://issues.guix.gnu.org} is powered by Mumi, a nice piece of
software written in Guile, and you can help! See
@url{https://git.elephly.net/gitweb.cgi?p=software/mumi.git}.}. To view
discussions related to issue number @var{n}, go to
@indicateurl{https://issues.guix.gnu.org/issue/@var{n}} or
@indicateurl{https://bugs.gnu.org/@var{n}}.
If you use Emacs, you may find it more convenient to interact with
issues using @file{debbugs.el}, which you can install with:
@example
guix install emacs-debbugs
@end example
For example, to list all open issues on @code{guix-patches}, hit:
@example
@kbd{C-u} @kbd{M-x} debbugs-gnu @kbd{RET} @kbd{RET} guix-patches @kbd{RET} n y
@end example
@xref{Top,,, debbugs-ug, Debbugs User Guide}, for more information on
this nifty tool!

View File

@ -21,7 +21,7 @@
@set SUBSTITUTE-URL https://@value{SUBSTITUTE-SERVER} @set SUBSTITUTE-URL https://@value{SUBSTITUTE-SERVER}
@copying @copying
Copyright @copyright{} 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 Ludovic Courtès@* Copyright @copyright{} 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Ludovic Courtès@*
Copyright @copyright{} 2013, 2014, 2016 Andreas Enge@* Copyright @copyright{} 2013, 2014, 2016 Andreas Enge@*
Copyright @copyright{} 2013 Nikita Karetnikov@* Copyright @copyright{} 2013 Nikita Karetnikov@*
Copyright @copyright{} 2014, 2015, 2016 Alex Kost@* Copyright @copyright{} 2014, 2015, 2016 Alex Kost@*