[gentoo-commits] proj/devmanual:master commit in: keywording/

["Ulrich Müller" <ulm@gentoo.org>]

commit:     5415582aaa5845c3b71501f92ad8e547bd1c0c30
Author:     Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Sun Mar 21 08:58:33 2021 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Wed Apr  7 17:35:13 2021 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=5415582a

keywording: expound on NATTkA importance and HOWTO

Signed-off-by: Sam James <sam <AT> gentoo.org>
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>

 keywording/text.xml | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/keywording/text.xml b/keywording/text.xml
index 9e7177e..f57e18a 100644
--- a/keywording/text.xml
+++ b/keywording/text.xml
@@ -260,6 +260,41 @@ That way, teams can remove themselves from the list when they are done, giving
 a clear indication of which teams still remain to stabilize a package.
 </p>
 
+<p>
+It is <e>strongly</e>
+<uri link="https://archives.gentoo.org/gentoo-dev/message/cd62f6be924f6a0f76b68a07d33b256a">
+recommended</uri> that <c>NATTkA</c> be used to file keywording or
+stabilization bugs to ensure that arches are not accidentally forgot about;
+the automation removes an often error-prone step in the arch-testing process.
+Ask in #gentoo-dev or on the gentoo-dev mailing list if you need help.
+</p>
+
+<p>
+<c>NATTkA</c> will set the <c>sanity-check</c> field on Bugzilla to either
+<c>-</c> or <c>+</c> depending on whether the package list results in a
+consistent dependency graph. You may need to add more packages or adjust the
+archs listed for each package based on the output the bot posts as a comment
+on the bug. Please note that arch teams may not process or notice bugs with a
+blank or <c>-</c> sanity-check, so please fix this if it occurs <d/> or ask for
+help to do so.
+</p>
+
+<note>
+Note that sometimes NATTkA may do <e>nothing</e> if it has concluded the package
+list is complete. You may wish to run <c>nattka sanity-check BUG</c> where
+<c>BUG</c> is the bug number you're having an issue with in order to debug the
+issue to receive verbose output.
+</note>
+
+<p>
+You may wish to read NATTkA's
+<uri link="https://github.com/mgorny/nattka#filing-keywordingstabilization-bugs">
+documentation</uri> for help on package list syntax or other information about
+the tool. The documentation details syntax which can be used, such as <c>*</c>
+to represent 'all previously stable arches', or '^' to copy the arches from the
+line(s) above.
+</p>
+
 <p>
 For an ebuild to move to stable, the following guidelines must be met
 (see <uri link="https://www.gentoo.org/glep/glep-0040.html">GLEP 40</uri>