aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Harder <radhermit@gmail.com>2015-04-01 21:33:37 -0400
committerTim Harder <radhermit@gmail.com>2015-04-01 21:33:37 -0400
commit62f1db665b83d9572aabde83b09592298a7690c2 (patch)
treee1a6847bff0e4d920ef3d4adeb06351d3158dd58 /README.rst
parentadd pypi badge to readme (diff)
downloadpkgcheck-62f1db665b83d9572aabde83b09592298a7690c2.tar.gz
pkgcheck-62f1db665b83d9572aabde83b09592298a7690c2.tar.bz2
pkgcheck-62f1db665b83d9572aabde83b09592298a7690c2.zip
add memory usage note to readme and remove old version matching line
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst16
1 files changed, 13 insertions, 3 deletions
diff --git a/README.rst b/README.rst
index 5d279d68..86b99f8f 100644
--- a/README.rst
+++ b/README.rst
@@ -7,9 +7,8 @@ pkgcheck
Dependencies
============
-pkgcheck is developed alongside pkgcore. To run the development version
-of pkgcheck you will need the development version of pkgcore. Otherwise
-the 0.x version numbers need to match.
+pkgcheck is developed alongside pkgcore_. To run the development version of
+pkgcheck you will need the development version of pkgcore.
The metadata.xml checks require either xmllint (installed as part of
libxml2) or the python bindings to libxml2 (installed as part of
@@ -23,6 +22,15 @@ as long as you are not root things should work. If you want to make
pkgcheck available system-wide use the provided ``setup.py``
(see `Installing python modules`_ for details).
+Notes
+=====
+
+Currently full tree scans will use a large amount of memory (up to ~1.7GB) in
+part due to pkgcore's restriction design in relation to the expanding use of
+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
=============
@@ -140,6 +148,8 @@ pkgcheck_reporter_factory``.
.. _`Installing python modules`: http://docs.python.org/inst/
+.. _pkgcore: https://github.com/pkgcore/pkgcore
+.. _pkgcore.restrictions: https://github.com/pkgcore/pkgcore/issues/80
.. |pypi| image:: https://img.shields.io/pypi/v/pkgcheck.svg
:target: https://pypi.python.org/pypi/pkgcheck