Merge pull request #2820 from j0057/config-docs

Document behavior of boolean config file variables (--no-cache and --no-compile)
pypa · Jun 23, 2015 · 7d69501 · 7d69501
2 parents 2a70d33 + 85a1036
commit 7d69501
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/docs/user_guide.rst b/docs/user_guide.rst
@@ -354,6 +354,17 @@ set like this:
     ignore-installed = true
     no-dependencies = yes
 
+To enable the boolean options ``--no-compile`` and ``--no-cache-dir``, falsy
+values have to be used:
+
+.. code-block:: ini
+
+    [global]
+    no-cache-dir = false
+
+    [install]
+    no-compile = no
+
 Appending options like ``--find-links`` can be written on multiple lines:
 
 .. code-block:: ini