summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Pipping <sebastian@pipping.org>2010-11-07 00:58:39 +0100
committerSebastian Pipping <sebastian@pipping.org>2010-11-07 00:58:39 +0100
commit46fb83877a68c5ddc1841e93695248772c500168 (patch)
tree47515160c6a69bb40e93a3a69079fdad46c99452
parent72042f2bc3d3f920753fddd68900a7ec057af813 (diff)
downloadlayman-46fb83877a68c5ddc1841e93695248772c500168.tar.gz
layman-46fb83877a68c5ddc1841e93695248772c500168.tar.bz2
layman-46fb83877a68c5ddc1841e93695248772c500168.zip
Improve documentation on option nocheck (bug #267686)
-rw-r--r--doc/layman.8.txt8
-rw-r--r--etc/layman.cfg14
2 files changed, 18 insertions, 4 deletions
diff --git a/doc/layman.8.txt b/doc/layman.8.txt
index be5c301..94fa650 100644
--- a/doc/layman.8.txt
+++ b/doc/layman.8.txt
@@ -111,11 +111,17 @@ List of other available *layman* options.
remote lists if you run the sync, list or fetch operation.
*-k*, *--nocheck*::
- Prevents *layman* from checking the remote lists of overlays for
+- When listing remote overlays (using *-L* or *--list*) *layman*
+ no longer hides overlays, for which you lack the tools to use.
+ By default, *layman* hides Git repositories if you do not have Git
+ installed. Same applies to Subversion, CVS and so forth.
+
+- Prevents *layman* from checking the remote lists of overlays for
complete overlay definitions. The default behavior for *layman* is
to reject overlays that do not provide a description or a contact
attribute.
+
*-q*, *--quiet*::
Makes *layman* completely quiet. In quiet mode child processes
will be run with stdin closed to avoid running into infinite and
diff --git a/etc/layman.cfg b/etc/layman.cfg
index b45c6f0..ea68e66 100644
--- a/etc/layman.cfg
+++ b/etc/layman.cfg
@@ -42,9 +42,17 @@ overlays : http://www.gentoo.org/proj/en/overlays/repositories.xml
#-----------------------------------------------------------
# Strict checking of overlay definitions
#
-# Set either to "yes" or "no". If "no" layman will issue
-# warnings if an overlay definition is missing either
-# description or contact information.
+# The nocheck option is a bit confusing, for historical reasons.
+# Hopefully this description eases the double negation trouble:
+#
+# nocheck : yes
+# - Accepts completene overlay entries without warnings
+# - Lists overlays of type foo (say Git) even with no foo installed
+#
+# nocheck : no
+# - Checks overlay entries for missing description or contact
+# information and issue warnings as needed
+# - Hides overlays of type foo (say Git) if foo not not installed
#
nocheck : yes