summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChris Marusich <cmmarusich@gmail.com>2021-06-22 19:44:18 -0700
committerChris Marusich <cmmarusich@gmail.com>2021-06-23 21:56:29 -0700
commit3c86372e36cecaed1ad55675ce32a14b972406bf (patch)
tree176a0ecf54dd70c1852d4361fefcccdbdffd5f95
parentd320daf7df3f5a50447158c1244bdc4fa57973ac (diff)
doc: Document the use of Debbugs usertags.
* 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 "The Issue Tracker", "Debbugs User Interfaces", and "Debbugs Usertags". Of these, only the "Debbugs Usertags" is actually new.
-rw-r--r--doc/contributing.texi66
1 files changed, 65 insertions, 1 deletions
diff --git a/doc/contributing.texi b/doc/contributing.texi
index e612ea7b23d..1f0160a7073 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -26,7 +26,7 @@ choice.
26* Packaging Guidelines:: Growing the distribution. 26* Packaging Guidelines:: Growing the distribution.
27* Coding Style:: Hygiene of the contributor. 27* Coding Style:: Hygiene of the contributor.
28* Submitting Patches:: Share your work. 28* Submitting Patches:: Share your work.
29* Tracking Bugs and Patches:: Using Debbugs. 29* Tracking Bugs and Patches:: Keeping it all organized.
30* Commit Access:: Pushing to the official repository. 30* Commit Access:: Pushing to the official repository.
31* Updating the Guix Package:: Updating the Guix package definition. 31* Updating the Guix Package:: Updating the Guix package definition.
32* Translating Guix:: Make Guix speak your native language. 32* Translating Guix:: Make Guix speak your native language.
@@ -1223,6 +1223,18 @@ for more information. You can install @command{git send-email} with
1223@node Tracking Bugs and Patches 1223@node Tracking Bugs and Patches
1224@section Tracking Bugs and Patches 1224@section Tracking Bugs and Patches
1225 1225
1226This section describes how the Guix project tracks its bug reports and
1227patch submissions.
1228
1229@menu
1230* The Issue Tracker:: The official bug and patch tracker.
1231* Debbugs User Interfaces:: Ways to interact with Debbugs.
1232* Debbugs Usertags:: Tag reports with custom labels.
1233@end menu
1234
1235@node The Issue Tracker
1236@subsection The Issue Tracker
1237
1226@cindex bug reports, tracking 1238@cindex bug reports, tracking
1227@cindex patch submissions, tracking 1239@cindex patch submissions, tracking
1228@cindex issue tracking 1240@cindex issue tracking
@@ -1234,6 +1246,9 @@ email to @email{bug-guix@@gnu.org}, while patch submissions are filed
1234against the @code{guix-patches} package by sending email to 1246against the @code{guix-patches} package by sending email to
1235@email{guix-patches@@gnu.org} (@pxref{Submitting Patches}). 1247@email{guix-patches@@gnu.org} (@pxref{Submitting Patches}).
1236 1248
1249@node Debbugs User Interfaces
1250@subsection Debbugs User Interfaces
1251
1237A web interface (actually @emph{two} web interfaces!) are available to 1252A web interface (actually @emph{two} web interfaces!) are available to
1238browse issues: 1253browse issues:
1239 1254
@@ -1271,6 +1286,55 @@ For example, to list all open issues on @code{guix-patches}, hit:
1271@xref{Top,,, debbugs-ug, Debbugs User Guide}, for more information on 1286@xref{Top,,, debbugs-ug, Debbugs User Guide}, for more information on
1272this nifty tool! 1287this nifty tool!
1273 1288
1289@node Debbugs Usertags
1290@subsection Debbugs Usertags
1291
1292@cindex usertags, for debbugs
1293@cindex Debbugs usertags
1294Debbugs provides a feature called @dfn{usertags} that allows any user to
1295tag any bug with an arbitrary label. Bugs can be searched by usertag,
1296so this is a handy way to organize bugs@footnote{The list of usertags is
1297public information, and anyone can modify any user's list of usertags,
1298so keep that in mind if you choose to use this feature.}.
1299
1300For example, to view all the bug reports (or patches, in the case of
1301@code{guix-patches}) tagged with the usertag @code{powerpc64le-linux}
1302for the user @code{guix-devel@@gnu.org}, open a URL like the following
1303in a web browser:
1304@url{https://debbugs.gnu.org/cgi-bin/pkgreport.cgi?tag=powerpc64le-linux;users=guix-devel@@gnu.org}.
1305
1306For more information on how to use usertags, please refer to the
1307documentation for Debbugs or the documentation for whatever tool you use
1308to interact with Debbugs.
1309
1310In Guix, we are experimenting with usertags to keep track of
1311architecture-specific issues. To facilitate collaboration, all our
1312usertags are associated with the single user @code{guix-devel@@gnu.org}.
1313The following usertags currently exist for that user:
1314
1315@table @code
1316
1317@item powerpc64le-linux
1318The purpose of this usertag is to make it easy to find the issues that
1319matter most for the @code{powerpc64le-linux} system type. Please assign
1320this usertag to bugs or patches that affect @code{powerpc64le-linux} but
1321not other system types. In addition, you may use it to identify issues
1322that for some reason are particularly important for the
1323@code{powerpc64le-linux} system type, even if the issue affects other
1324system types, too.
1325
1326@item reproducibility
1327For issues related to reproducibility. For example, it would be
1328appropriate to assign this usertag to a bug report for a package that
1329fails to build reproducibly.
1330
1331@end table
1332
1333If you're a committer and you want to add a usertag, just start using it
1334with the @code{guix-devel@@gnu.org} user. If the usertag proves useful
1335to you, consider updating this section of the manual so that others will
1336know what your usertag means.
1337
1274@node Commit Access 1338@node Commit Access
1275@section Commit Access 1339@section Commit Access
1276 1340