diff mbox series

[bug#38846,1/4] doc: Add "Tracking Bugs and Patches" section.

Message ID 20200101163446.5132-1-ludo@gnu.org
State Accepted
Headers show
Series Move 'HACKING' to the manual, and a proposal for commit access | expand

Checks

Context Check Description
cbaines/applying patch fail Apply failed

Commit Message

Ludovic Courtès Jan. 1, 2020, 4:34 p.m. UTC
* 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.
---
 HACKING               | 11 +-------
 doc/contributing.texi | 62 ++++++++++++++++++++++++++++++++++++++-----
 doc/guix.texi         |  2 +-
 3 files changed, 58 insertions(+), 17 deletions(-)

Comments

Ricardo Wurmus Jan. 1, 2020, 6:07 p.m. UTC | #1
Ludovic Courtès <ludo@gnu.org> writes:

> * 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.

Looks good to me, thank you!
Simon Tournier Jan. 1, 2020, 6:18 p.m. UTC | #2
Hi Ludo,

On Wed, 1 Jan 2020 at 17:36, Ludovic Courtès <ludo@gnu.org> wrote:
>
> * 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.
> ---
>  HACKING               | 11 +-------
>  doc/contributing.texi | 62 ++++++++++++++++++++++++++++++++++++++-----
>  doc/guix.texi         |  2 +-
>  3 files changed, 58 insertions(+), 17 deletions(-)
>
> diff --git a/HACKING b/HACKING
> index 2f0f93f896..eeea2f6311 100644
> --- a/HACKING
> +++ b/HACKING
> @@ -2,7 +2,7 @@
>
>  #+TITLE: Hacking GNU Guix and Its Incredible Distro
>
> -Copyright © 2012, 2013, 2014, 2016, 2017, 2019 Ludovic Courtès <ludo@gnu.org>
> +Copyright © 2012, 2013, 2014, 2016, 2017, 2019, 2020 Ludovic Courtès <ludo@gnu.org>
>  Copyright © 2015, 2017 Mathieu Lirzin <mthl@gnu.org>
>  Copyright © 2017 Leo Famulari <leo@famulari.name>
>  Copyright © 2017 Arun Isaac <arunisaac@systemreboot.net>
> @@ -63,12 +63,3 @@ after two weeks, and if you’re confident, it’s OK to commit.
>
>  That last part is subject to being adjusted, allowing individuals to commit
>  directly on non-controversial changes on parts they’re 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

I thought the policy about copyright was when adding/changing lines,
not when removing them.

https://lists.gnu.org/archive/html/guix-devel/2019-10/msg00473.html

Maybe I miss something.
Just to notice.

Otherwise, nice!

Cheers,
simon
Ludovic Courtès Jan. 2, 2020, 11:51 a.m. UTC | #3
Hi Simon,

zimoun <zimon.toutoune@gmail.com> skribis:

> On Wed, 1 Jan 2020 at 17:36, Ludovic Courtès <ludo@gnu.org> wrote:
>>
>> * 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.
>> ---
>>  HACKING               | 11 +-------
>>  doc/contributing.texi | 62 ++++++++++++++++++++++++++++++++++++++-----
>>  doc/guix.texi         |  2 +-
>>  3 files changed, 58 insertions(+), 17 deletions(-)
>>
>> diff --git a/HACKING b/HACKING
>> index 2f0f93f896..eeea2f6311 100644
>> --- a/HACKING
>> +++ b/HACKING
>> @@ -2,7 +2,7 @@
>>
>>  #+TITLE: Hacking GNU Guix and Its Incredible Distro
>>
>> -Copyright © 2012, 2013, 2014, 2016, 2017, 2019 Ludovic Courtès <ludo@gnu.org>
>> +Copyright © 2012, 2013, 2014, 2016, 2017, 2019, 2020 Ludovic Courtès <ludo@gnu.org>
>>  Copyright © 2015, 2017 Mathieu Lirzin <mthl@gnu.org>
>>  Copyright © 2017 Leo Famulari <leo@famulari.name>
>>  Copyright © 2017 Arun Isaac <arunisaac@systemreboot.net>
>> @@ -63,12 +63,3 @@ after two weeks, and if you’re confident, it’s OK to commit.
>>
>>  That last part is subject to being adjusted, allowing individuals to commit
>>  directly on non-controversial changes on parts they’re 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
>
> I thought the policy about copyright was when adding/changing lines,
> not when removing them.
>
> https://lists.gnu.org/archive/html/guix-devel/2019-10/msg00473.html
>
> Maybe I miss something.
> Just to notice.

Ah well, I have (add-hook 'write-file-functions 'copyright-update),
which took care of it.  :-)

Some projects (such as Gnulib) automatically update copyright years each
1st of January, so there are different practices.  But anyway, you’re
right that it’s a bit odd to add a new year here, I’ll remove it.

Thanks,
Ludo’.
Simon Tournier Jan. 2, 2020, 6:40 p.m. UTC | #4
Hi Ludo,

On Thu, 2 Jan 2020 at 12:51, Ludovic Courtès <ludo@gnu.org> wrote:

> Ah well, I have (add-hook 'write-file-functions 'copyright-update),
> which took care of it.  :-)

Ah cool!
I did not know this neat function. :-)


Cheers,
simon
diff mbox series

Patch

diff --git a/HACKING b/HACKING
index 2f0f93f896..eeea2f6311 100644
--- a/HACKING
+++ b/HACKING
@@ -2,7 +2,7 @@ 
 
 #+TITLE: Hacking GNU Guix and Its Incredible Distro
 
-Copyright © 2012, 2013, 2014, 2016, 2017, 2019 Ludovic Courtès <ludo@gnu.org>
+Copyright © 2012, 2013, 2014, 2016, 2017, 2019, 2020 Ludovic Courtès <ludo@gnu.org>
 Copyright © 2015, 2017 Mathieu Lirzin <mthl@gnu.org>
 Copyright © 2017 Leo Famulari <leo@famulari.name>
 Copyright © 2017 Arun Isaac <arunisaac@systemreboot.net>
@@ -63,12 +63,3 @@  after two weeks, and if you’re confident, it’s OK to commit.
 
 That last part is subject to being adjusted, allowing individuals to commit
 directly on non-controversial changes on parts they’re 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
diff --git a/doc/contributing.texi b/doc/contributing.texi
index e656676c0f..fd27f037e9 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -26,6 +26,7 @@  choice.
 * Packaging Guidelines::        Growing the distribution.
 * Coding Style::                Hygiene of the contributor.
 * Submitting Patches::          Share your work.
+* Tracking Bugs and Patches::   Using Debbugs.
 @end menu
 
 @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
 format-patch} sent to the @email{guix-patches@@gnu.org} mailing list.
 
-This mailing list is backed by a Debbugs instance accessible at
-@uref{https://bugs.gnu.org/guix-patches}, which allows us to keep track
-of submissions.  Each message sent to that mailing list gets a new
-tracking number assigned; people can then follow up on the submission by
-sending email to @code{@var{NNN}@@debbugs.gnu.org}, where @var{NNN} is
-the tracking number (@pxref{Sending a Patch Series}).
+This mailing list is backed by a Debbugs instance, which allows us to
+keep track of submissions (@pxref{Tracking Bugs and Patches}).  Each
+message sent to that mailing list gets a new tracking number assigned;
+people can then follow up on the submission by sending email to
+@code{@var{NNN}@@debbugs.gnu.org}, where @var{NNN} is the tracking
+number (@pxref{Sending a Patch Series}).
 
 Please write commit logs in the ChangeLog format (@pxref{Change Logs,,,
 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
 @command{guix install git:send-email}.
 @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!
diff --git a/doc/guix.texi b/doc/guix.texi
index 70e3dfea6a..999b7c9421 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -21,7 +21,7 @@ 
 @set SUBSTITUTE-URL https://@value{SUBSTITUTE-SERVER}
 
 @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 Nikita Karetnikov@*
 Copyright @copyright{} 2014, 2015, 2016 Alex Kost@*