aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Harder <radhermit@gmail.com>2019-10-01 23:30:15 -0600
committerTim Harder <radhermit@gmail.com>2019-10-01 23:30:15 -0600
commitce2c603e95a1822d9382550a5a7e01f4d56624dc (patch)
tree620476407162febaa3bf761902d6ee72069d6c0d /README.rst
parentvarious check/result naming consistency changes (diff)
downloadpkgcheck-ce2c603e95a1822d9382550a5a7e01f4d56624dc.tar.gz
pkgcheck-ce2c603e95a1822d9382550a5a7e01f4d56624dc.tar.bz2
pkgcheck-ce2c603e95a1822d9382550a5a7e01f4d56624dc.zip
readme: drop the entire, outdated config section
An updated config section might be added to the manpage later once config support is reworked.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst54
1 files changed, 0 insertions, 54 deletions
diff --git a/README.rst b/README.rst
index f0c12e5e..f7e6e85b 100644
--- a/README.rst
+++ b/README.rst
@@ -55,60 +55,6 @@ transitive use flag dependencies across the tree. To alleviate this
pkgcore.restrictions_ will be refactored, probably leading to splitting
conditionals off into their own set.
-Configuration
-=============
-
-No configuration is required, but some configuration makes ``pkgcheck``
-easier to use.
-
-Checksets
----------
-
-By default ``pkgcheck scan`` runs all available checks. This is not always
-desired. For example, checks about missing stable keywords are often
-just noise in the output for ebuild devs. A checkset defines a subset
-of checks to run. There are two kinds: one enabling a specific set of
-checks and one running every available check except for the specified
-ones. Examples::
-
- [no-arch-checks]
- class=pkgcheck.base.Blacklist
- patterns=unstable_only stablereq imlate
-
- [only-arch-checks]
- class=pkgcheck.base.Whitelist
- patterns=unstable_only stablereq imlate
-
-The first disables the three specified checks, the second enables only
-those three. For available names see ``pkgcheck show --checks``.
-
-``patterns`` is a whitespace-separated list. If the values are strings
-they need to match a component of the name in ``pkgcheck show --checks``
-exactly. If it looks like a regexp (currently defined as "contains a +
-or \*") this needs to match the entire name.
-
-Checksets called ``no-arch-checks`` and ``all-checks`` are defined by
-default.
-
-There are various ways to pick the checkset to use: ``pquery
---checkset``, the checkset setting of a suite and setting
-``default=true`` on a checkset in the configuration.
-
-Reporters
----------
-
-By default the output is in a colorful human-readable format. For full
-tree checks this format may not be optimal since it is a bit hard to
-grep. To use an output format that prints everything on one line, put
-this in your configuration::
-
- [pkgcheck-plain-reporter]
- class=pkgcheck.reporters.plain_reporter
- default=true
-
-To use a non-default reporter use ``pkgcheck scan -R/--reporter``. To see the
-reporters available use ``pkgcheck show --reporters``.
-
.. _`Installing python modules`: http://docs.python.org/inst/
.. _pkgcore: https://github.com/pkgcore/pkgcore