From: Joel Rosdahl <joel@rosdahl.net>
Date: Thu, 14 Apr 2016 18:15:53 +0000 (+0200)
Subject: Make it harder to misinterpret semantics of boolean environment settings
X-Git-Tag: v3.2.5~4
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f6dfd815f7eae4e12c83ee4a9159333425782fe1;p=thirdparty%2Fccache.git

Make it harder to misinterpret semantics of boolean environment settings

As suggested by Jim Klimov.
---

diff --git a/MANUAL.txt b/MANUAL.txt
index c6484bbc5..99930194b 100644
--- a/MANUAL.txt
+++ b/MANUAL.txt
@@ -232,7 +232,7 @@ Configuration settings
 
 Below is a list of available configuration settings. The corresponding
 environment variable name is indicated in parentheses after each configuration
-setting key. Boolean options are indicated with ``[boolean]''
+setting key.
 
 *base_dir* (*CCACHE_BASEDIR*)::
 
@@ -314,7 +314,7 @@ WRAPPERS>>.
 --
 --
 
-*compression* (*CCACHE_COMPRESS*) [boolean]::
+*compression* (*CCACHE_COMPRESS* or *CCACHE_NOCOMPRESS*, see <<_boolean_values,Boolean values>> above)::
 
     If true, ccache will compress object files and other compiler output it
     puts in the cache. However, this setting has no effect on how files are
@@ -336,12 +336,12 @@ WRAPPERS>>.
     compiled, but that sometimes doesn't work. For example, when using the
     ``aCC'' compiler on HP-UX, set the cpp extension to *i*.
 
-*direct_mode* (*CCACHE_DIRECT*) [boolean]::
+*direct_mode* (*CCACHE_DIRECT* or *CCACHE_NODIRECT*, see <<_boolean_values,Boolean values>> above)::
 
     If true, the direct mode will be used. The default is true. See
     <<_the_direct_mode,THE DIRECT MODE>>.
 
-*disable* (*CCACHE_DISABLE*) [boolean]::
+*disable* (*CCACHE_DISABLE* or *CCACHE_NODISABLE*, see <<_boolean_values,Boolean values>> above)::
 
     When true, ccache will just call the real compiler, bypassing the cache
     completely. The default is false.
@@ -352,7 +352,7 @@ WRAPPERS>>.
     the hash sum that idetifies the build. The list separator is semicolon on
     Windows systems and colon on other systems.
 
-*hard_link* (*CCACHE_HARDLINK*) [boolean]::
+*hard_link* (*CCACHE_HARDLINK* or *CCACHE_NOHARDLINK*, see <<_boolean_values,Boolean values>> above)::
 
     If true, ccache will attempt to use hard links from the cache directory
     when creating the compiler output rather than using a file copy. Using hard
@@ -363,7 +363,7 @@ WRAPPERS>>.
     compressed cache files. This means that you should not enable compression
     if you want to use hard links. The default is false.
 
-*hash_dir* (*CCACHE_HASHDIR*) [boolean]::
+*hash_dir* (*CCACHE_HASHDIR* or *CCACHE_NOHASHDIR*, see <<_boolean_values,Boolean values>> above)::
 
     If true, ccache will include the current working directory in the hash that
     is used to distinguish two compilations. This prevents a problem with the
@@ -405,25 +405,25 @@ WRAPPERS>>.
     <<_using_ccache_with_other_compiler_wrappers,USING CCACHE WITH OTHER
     COMPILER WRAPPERS>>.
 
-*read_only* (*CCACHE_READONLY*) [boolean]::
+*read_only* (*CCACHE_READONLY* or *CCACHE_NOREADONLY*, see <<_boolean_values,Boolean values>> above)::
 
     If true, ccache will attempt to use existing cached object files, but it
     will not to try to add anything new to the cache. If you are using this
     because your ccache directory is read-only, then you need to set
     *temporary_dir* as otherwise ccache will fail to create temporary files.
 
-*read_only_direct* (*CCACHE_READONLY_DIRECT*) [boolean]::
+*read_only_direct* (*CCACHE_READONLY_DIRECT* or *CCACHE_NOREADONLY_DIRECT*, see <<_boolean_values,Boolean values>> above)::
 
     Just like *read_only* except that ccache will only try to retrieve results
     from the cache using the direct mode, not the preprocessor mode. See
     documentation for *read_only* regarding using a read-only ccache directory.
 
-*recache* (*CCACHE_RECACHE*) [boolean]::
+*recache* (*CCACHE_RECACHE* or *CCACHE_NORECACHE*, see <<_boolean_values,Boolean values>> above)::
 
     If true, ccache will not use any previously stored result. New results will
     still be cached, possibly overwriting any pre-existing results.
 
-*run_second_cpp* (*CCACHE_CPP2*) [boolean]::
+*run_second_cpp* (*CCACHE_CPP2* or *CCACHE_NOCPP2*, see <<_boolean_values,Boolean values>> above)::
 
     If true, ccache will not use the optimisation of avoiding the second call
     to the preprocessor by compiling the preprocessed output that was used for
@@ -463,7 +463,7 @@ WRAPPERS>>.
 See the discussion under <<_troubleshooting,TROUBLESHOOTING>> for more
 information.
 
-*stats* (*CCACHE_STATS*) [boolean]::
+*stats* (*CCACHE_STATS* or *CCACHE_NOSTATS*, see <<_boolean_values,Boolean values>> above)::
 
     If true, ccache will update the statistics counters on each compilation.
     The default is true.
@@ -484,7 +484,7 @@ NOTE: In previous versions of ccache, *CCACHE_TEMPDIR* had to be on the same
     with other users. Note that this also affects the file permissions set on
     the object files created from your compilations.
 
-*unify* (*CCACHE_UNIFY*) [boolean]::
+*unify* (*CCACHE_UNIFY* or *CCACHE_NOUNIFY*, see <<_boolean_values,Boolean values>> above)::
 
     If true, ccache will use a C/C++ unifier when hashing the preprocessor
     output if the *-g* option is not used. The unifier is slower than a normal
diff --git a/NEWS.txt b/NEWS.txt
index 5f8eb7009..7e3b7be35 100644
--- a/NEWS.txt
+++ b/NEWS.txt
@@ -12,6 +12,9 @@ New features and improvements
 
 - Improved handling of stale NFS handles.
 
+- Made it harder to misinterpret documentation of boolean environment settings'
+  semantics.
+
 
 Bug fixes
 ~~~~~~~~~