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

[Ulrich Müller]

commit:     ce22a0be5e11107c59d6f07fb508b5ff35cdf110
Author:     Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Mon Mar 22 06:19:51 2021 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Mar 30 06:53:24 2021 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=ce22a0be

eclass-writing: mention pkgcheck usage for checking eclass docs

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

 eclass-writing/text.xml | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml
index 6ac9f0d..288008d 100644
--- a/eclass-writing/text.xml
+++ b/eclass-writing/text.xml
@@ -151,6 +151,14 @@ multiline freetext, the <c>@CODE</c> tag should be used when necessary
 to create unformatted code chunks (such as example code) by placing
 the tag at the beginning and the end.
 </p>
+
+<p>
+Note that <c>pkgcheck</c> can check for issues in eclass documentation.
+You could run e.g. <c>pkgcheck scan -s eclass</c> to check for issues
+in the tree or <c>pkgcheck scan --commits</c> to check for issues
+in your staged git commits.
+</p>
+
 </body>
 </section>