diff options
| author |   Tim Harder <radhermit@gmail.com> | 2020-01-31 17:40:15 -0700 |
|---|---|---|
| committer | Tim Harder <radhermit@gmail.com> | 2020-01-31 18:25:38 -0700 |
| commit | 03855f3ef3168bb86cc9efc3ab7c4680e8e988e5 (patch) | |
| tree | ec54bd345f2b4047c236cb57b973c86c13ce6380 /doc | |
| parent | pkgcheck scan: add config support for non-value options, e.g. --net (diff) | |
| download | pkgcheck-03855f3ef3168bb86cc9efc3ab7c4680e8e988e5.tar.gz pkgcheck-03855f3ef3168bb86cc9efc3ab7c4680e8e988e5.tar.bz2 pkgcheck-03855f3ef3168bb86cc9efc3ab7c4680e8e988e5.zip | |
doc: add initial config file documentation to man page
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/config.rst | 49 | ||||
| -rw-r--r-- | doc/man/pkgcheck.rst | 2 |
2 files changed, 51 insertions, 0 deletions
diff --git a/doc/config.rst b/doc/config.rst new file mode 100644 index 00000000..13bc9613 --- /dev/null +++ b/doc/config.rst @@ -0,0 +1,49 @@ +Config file support +=================== + +Config files are supported by ``pkgcheck scan`` from any of three locations. +Listed in order of increasing precedence these include the following: + +- system config -- /etc/pkgcheck/pkgcheck.conf +- user config -- ~/.config/pkgcheck/pkgcheck.conf +- repo config -- metadata/pkgcheck.conf inside an ebuild repo + +Any settings from a config file with higher precedence will override matching +settings from a config file with a lower precedence, e.g. repo settings +override both user and system settings. + +In terms of file structure, basic INI formatting is required and allows +creating a default section for system-wide settings or repo-specific sections. +The INI key-value pairs directly relate to the available long-options supported +by ``pkgcheck scan`` and their related values. See the following examples for +how certain config settings affect scanning runs. + +Example 1 +--------- +Disable selected checks by default for all scanning runs:: + + [DEFAULT] + checks = -UnstableOnlyCheck,-RedundantVersionCheck + +Example 2 +--------- +Disable showing info level results for the gentoo repo:: + + [gentoo] + keywords = -info + +Example 3 +--------- +Restrict scanning to the amd64 and x86 arches/profiles for the gentoo repo:: + + [gentoo] + arches = amd64,x86 + +Example 4 +--------- +Enable network checks that require Internet access for the gentoo repo using +a custom timeout of 15 seconds:: + + [gentoo] + net = + timeout = 15 diff --git a/doc/man/pkgcheck.rst b/doc/man/pkgcheck.rst index a5da3c59..8495be8a 100644 --- a/doc/man/pkgcheck.rst +++ b/doc/man/pkgcheck.rst @@ -11,6 +11,8 @@ pkgcheck .. include:: pkgcheck/checks.rst .. include:: pkgcheck/reporters.rst +.. include:: ../config.rst + Reporting Bugs ============== |