aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Harder <radhermit@gmail.com>2016-06-19 11:52:11 -0400
committerTim Harder <radhermit@gmail.com>2016-06-19 11:52:11 -0400
commitd294da5ca42a72ed8b4a18179413e2c8bf1c6b67 (patch)
treeaba263ade4afc19b43341fccda382aa85b973b84 /README.rst
parentdrop -o/--overlayed-repo support (rely on properly configured masters) (diff)
downloadpkgcheck-d294da5ca42a72ed8b4a18179413e2c8bf1c6b67.tar.gz
pkgcheck-d294da5ca42a72ed8b4a18179413e2c8bf1c6b67.tar.bz2
pkgcheck-d294da5ca42a72ed8b4a18179413e2c8bf1c6b67.zip
readme: update docs to note removed -o/--overlayed-repo support
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst27
1 files changed, 4 insertions, 23 deletions
diff --git a/README.rst b/README.rst
index 920c9fd4..e47c34dd 100644
--- a/README.rst
+++ b/README.rst
@@ -71,17 +71,10 @@ it is used. So with the following suite definition in
you can run ``pkgcheck`` with no further arguments inside your portage
directory and it will do the right thing.
-For use with overlays you need to define the "source" repo too::
-
- [pkgcheck-overlay-suite]
- class=pkgcheck.base.Suite
- target_repo=/usr/local/portage/private
- src_repo=gentoo
-
-(the ``target_repo`` and ``src_repo`` settings are both names of
-repository sections, not arbitrary filesystem paths).
-
-See Overlays_ for more information on ``src_repo``.
+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::
@@ -129,18 +122,6 @@ 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.
-Overlays
---------
-
-Checking just an overlay does not work very well since pkgcheck
-needs to know about profiles and checks if all dependencies are
-available. To do this you will usually have to specify a base or
-"source" repo to pull this data from. You can set this with ``pkgcheck
---overlayed-repo`` or the ``pkgcheck -o`` shorthand, or you can set it
-in the configuration file as part of a suite__ definition.
-
-__ Suites_
-
Reporters
---------