diff options
| author |   Sam James <sam@gentoo.org> | 2021-03-22 06:19:51 +0000 |
|---|---|---|
| committer |   Ulrich Müller <ulm@gentoo.org> | 2021-03-30 08:53:24 +0200 |
| commit | ce22a0be5e11107c59d6f07fb508b5ff35cdf110 (patch) | |
| tree | 06c37288dd708f65e9dc9c21c239c488371a9739 | |
| parent | eclass-writing: mention that prefixing with the eclass name is "namespacing" (diff) | |
| download | devmanual-ce22a0be.tar.gz devmanual-ce22a0be.tar.bz2 devmanual-ce22a0be.zip | |
eclass-writing: mention pkgcheck usage for checking eclass docs
Signed-off-by: Sam James <sam@gentoo.org>
Signed-off-by: Ulrich Müller <ulm@gentoo.org>
| -rw-r--r-- | eclass-writing/text.xml | 8 |
1 files changed, 8 insertions, 0 deletions
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> |