Re: Debbugs user tags

[Chris Marusich]

Ludovic Courtès <ludo@gnu.org> writes:

>> * doc/contributing.texi (Contributing): Update the short description of the
>> "Tracking Bugs and Patches" chapter in the menu.
>> (Tracking Bugs and Patches): Split this section into three new subsections,
>> titled "Debbugs", "Debbugs User Interfaces", and "Debbugs Usertags".  Of
>> these, only the "Debbugs Usertags" is actually new.
>
> Wonderful!

I'm glad you like it!  :-)

>> +++ b/doc/contributing.texi
>> @@ -26,7 +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.
>> +* Tracking Bugs and Patches::   Keeping it all organized.
>
> You probably have to adjust it in a second place (yeah…).

Other references to "Tracking Bugs and Patches" do exist, but they don't
mention "Using Debbugs," so I don't think they need to be updated.

>> +@menu
>> +* Debbugs:: The official bug and patch tracker.
>> +* Debbugs User Interfaces:: Ways to interact with Debbugs.
>> +* Debbugs Usertags:: Tag reports with custom labels.
>> +@end menu
>
> ‘M-x texinfo-make-menu’ or similar should indent it for you.  :-)

You learn something new every day!

>> +@node Debbugs
>> +@subsection Debbugs
>
> Maybe rename to “The Issue Tracker”, so as to not require knowledge of
> what Debbugs is when skimming through the table of contents?

Sounds good.  I just changed the first subsection, so now it looks like
this:

--8<---------------cut here---------------start------------->8---
@menu
* The Issue Tracker::           The official bug and patch tracker.
* Debbugs User Interfaces::     Ways to interact with Debbugs.
* Debbugs Usertags::            Tag reports with custom labels.
@end menu
--8<---------------cut here---------------end--------------->8---

This seems fine, since the first subsection introduces Debbugs.

>> +Debbugs provides a feature called ``usertags'' that allows any user to
>
> @dfn{usertags}

OK.

>> +In Guix, we are experimenting with usertags to keep track of
>> +architecture-specific issues.  To facilitate collaboration, all our
>> +usertags are associated with the single user @code{guix-devel@@gnu.org}.
>> +The following usertags currently exist for that user:
>> +
>> +@table @code
>> +
>> +@item powerpc64le-linux
>> +The purpose of this usertag is to make it easy to find the issues that
>> +matter most for the @code{powerpc64le-linux} system type.  Please assign
>> +this usertag to issues or patches that affect @code{powerpc64le-linux}
>> +but not other system types.  In addition, you may use it to identify
>> +issues that for some reason are particularly important for the
>> +@code{powerpc64le-linux} system type, even if the issue affects other
>> +system types, too.
>
> Maybe we can already add ‘reproducibility’.
>
> Otherwise LGTM, thank you!
>
> Ludo’.

I added this text:

--8<---------------cut here---------------start------------->8---
@item reproducibility
For issues related to reproducibility.  For example, it would be
appropriate to assign this usertag to a bug report for a package that
fails to build reproducibly.
--8<---------------cut here---------------end--------------->8---

I've gone ahead and committed these changes in
3c86372e36cecaed1ad55675ce32a14b972406bf.  I verified that the Texinfo
manual could be built, and that when viewing it in Info, it looks as
expected.

Please let me know if you'd like any further changes; I'd be happy to
make them.

-- 
Chris

signature.asc
Description: PGP signature