aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Harder <radhermit@gmail.com>2019-08-05 11:12:42 -0600
committerTim Harder <radhermit@gmail.com>2019-08-05 11:36:00 -0600
commit85831e7e6134e86744bdef05724f4a810413f5d7 (patch)
treeafcdbeea92e96a83aba32b11d4acf78df8bdd43f /README.rst
parenttests: pkgcheck scan: add cwd limiter check (diff)
downloadpkgcheck-85831e7e6134e86744bdef05724f4a810413f5d7.tar.gz
pkgcheck-85831e7e6134e86744bdef05724f4a810413f5d7.tar.bz2
pkgcheck-85831e7e6134e86744bdef05724f4a810413f5d7.zip
pkgcheck: drop -s/--suite support
Similar support might be brought back later under a simplified format using a pkgcheck specific config file.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst41
1 files changed, 0 insertions, 41 deletions
diff --git a/README.rst b/README.rst
index 8a0c4f90..1088ac94 100644
--- a/README.rst
+++ b/README.rst
@@ -61,47 +61,6 @@ Configuration
No configuration is required, but some configuration makes ``pkgcheck``
easier to use.
-Suites
-------
-
-With no configuration it will try to guess the repository to use based
-on your working directory and the list of repositories pkgcore knows
-about. This will usually not quite work because the same location
-often has multiple "repositories" with a slightly different
-configuration and ``pkgcheck`` cannot guess which one to use.
-
-Defining "suites" in the configuration solves this ambiguity. A
-"suite" contains a target repository, optionally a source repository
-to use as a base and optionally a set of checks to run. If there is a
-single suite with a target repository containing the current directory
-it is used. So with the following suite definition in
-``~/.config/pkgcore/pkgcore.conf``::
-
- [pkgcheck-gentoo-suite]
- class=pkgcheck.base.Suite
- target_repo=gentoo
-
-you can run ``pkgcheck scan`` with no further arguments inside your portage
-directory and it will do the right thing.
-
-Make sure the target repo properly specifies its masters in
-metadata/layout.conf if it's meant to be an overlay, otherwise many errors are
-likely to be produced relating to missing licenses, categories, dependencies,
-etc.
-
-Finally, you can define a different checkset per suite::
-
- [pkgcheck-gentoo-suite]
- class=pkgcheck.base.Suite
- target_repo=gentoo
- checkset=no-arch-checks
-
-This disables checks that are not interesting unless you can set
-stable keywords for this suite. See Checksets_ for more information.
-
-Instead of relying on the working directory to pick the right suite
-you can specify one explicitly with ``pkgcheck scan -s/--suite``.
-
Checksets
---------