diff options
| author |   Tim Harder <radhermit@gmail.com> | 2020-01-31 21:55:07 -0700 |
|---|---|---|
| committer | Tim Harder <radhermit@gmail.com> | 2020-01-31 21:55:07 -0700 |
| commit | 84e6f9bb78c63a49aaf1af9647d27bb541347973 (patch) | |
| tree | c2ddf3f1bffbf8a44e9690c48f6482680091d57a /doc | |
| parent | doc/config.rst: add example showing default target repo override (diff) | |
| download | pkgcheck-84e6f9bb78c63a49aaf1af9647d27bb541347973.tar.gz pkgcheck-84e6f9bb78c63a49aaf1af9647d27bb541347973.tar.bz2 pkgcheck-84e6f9bb78c63a49aaf1af9647d27bb541347973.zip | |
doc/config.rst: simplify example list
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/config.rst | 28 |
1 files changed, 8 insertions, 20 deletions
diff --git a/doc/config.rst b/doc/config.rst index 46b5b092..4b3e9cbd 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -16,49 +16,37 @@ 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. +how certain config settings affect scanning runs: -Example 1 ---------- -Disable selected checks by default for all scanning runs:: +- Disable selected checks by default for all scanning runs:: [DEFAULT] checks = -UnstableOnlyCheck,-RedundantVersionCheck -Example 2 ---------- -Disable showing info level results for the gentoo repo:: +- 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:: +- 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:: +- Enable network checks that require Internet access for the gentoo repo using + a custom timeout of 15 seconds:: [gentoo] net = timeout = 15 -Example 5 ---------- -Use the JSON reporter by default for scanning output and disable all cache usage:: +- Use the JSON reporter by default for scanning output and disable all cache usage:: [DEFAULT] reporter = JsonReporter cache = no -Example 6 ---------- -Set the default repo to target when scanning:: +- Set the default repo to target when scanning:: [DEFAULT] repo = my_overlay |