aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTim Harder <radhermit@gmail.com>2019-07-21 06:54:28 -0600
committerTim Harder <radhermit@gmail.com>2019-07-21 07:01:01 -0600
commit1441f22ced8788fb3b5c8964c1594a8909a6cefa (patch)
treefa227780cc17e6941c1fe1733aef556717b906fe /doc
parentchecks.repo_metadata: initial LaggingProfileEAPI keyword (diff)
downloadpkgcheck-1441f22ced8788fb3b5c8964c1594a8909a6cefa.tar.gz
pkgcheck-1441f22ced8788fb3b5c8964c1594a8909a6cefa.tar.bz2
pkgcheck-1441f22ced8788fb3b5c8964c1594a8909a6cefa.zip
doc: update man page sections for pkgcheck show
Diffstat (limited to 'doc')
-rwxr-xr-xdoc/generate/pkgcheck/checks.py14
-rwxr-xr-xdoc/generate/pkgcheck/keywords.py6
2 files changed, 13 insertions, 7 deletions
diff --git a/doc/generate/pkgcheck/checks.py b/doc/generate/pkgcheck/checks.py
index 9cd48139..0f2b3f34 100755
--- a/doc/generate/pkgcheck/checks.py
+++ b/doc/generate/pkgcheck/checks.py
@@ -2,6 +2,18 @@
#
# Output rst doc for defined pkgcheck checks.
+"""
+Checks
+======
+
+List of checks that can be selected to run.
+
+By default, all checks that operate at the current scope or below will be run.
+In other words, if running inside a package directory in a repo, only checks
+that operate at a package or version scope will be run. On the other hand, when
+running against an entire repo, all defined checks will be run.
+"""
+
from collections import defaultdict
import sys
from textwrap import dedent
@@ -27,8 +39,6 @@ def main(f=sys.stdout, **kwargs):
for check in _known_checks:
d[check.scope].add(check)
- _rst_header('=', 'Checks', newline=False)
-
scopes = ('version', 'package', 'category', 'repository')
for scope in reversed(sorted(d)):
_rst_header('-', scopes[scope].capitalize() + ' scope')
diff --git a/doc/generate/pkgcheck/keywords.py b/doc/generate/pkgcheck/keywords.py
index 8a3e675a..df429f67 100755
--- a/doc/generate/pkgcheck/keywords.py
+++ b/doc/generate/pkgcheck/keywords.py
@@ -6,11 +6,7 @@
Keywords
========
-List of result keywords that can be produced by pkgcheck separated by scope.
-
-Use \`pkgcheck --list-keywords\` to see the list. Note that running in verbose
-mode (e.g. \`pkgcheck --list-keywords -v\`) will colorize and sort the output
-into scopes.
+List of result keywords that can be produced by pkgcheck.
"""
import sys