From: Joel Rosdahl <joel@rosdahl.net>
Date: Sun, 5 Jul 2020 19:33:47 +0000 (+0200)
Subject: Align command line option list in manual with help text
X-Git-Tag: v4.0~352
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=e24bd806601f9780826b3321e3f70f5b3eb4340e;p=thirdparty%2Fccache.git

Align command line option list in manual with help text
---

diff --git a/doc/MANUAL.adoc b/doc/MANUAL.adoc
index f883b0566..4e2ee5546 100644
--- a/doc/MANUAL.adoc
+++ b/doc/MANUAL.adoc
@@ -75,6 +75,10 @@ These options only apply when you invoke ccache as ``ccache''. When invoked as
 a compiler (via a symlink as described in the previous section), the normal
 compiler options apply and you should refer to the compiler's documentation.
 
+
+Common options
+~~~~~~~~~~~~~~
+
 *`-c`*, *`--cleanup`*::
 
     Clean up the cache by removing old cached files until the specified file
@@ -90,21 +94,6 @@ compiler options apply and you should refer to the compiler's documentation.
     Clear the entire cache, removing all cached files, but keeping the
     configuration file.
 
-*`--dump-manifest`* _PATH_::
-
-    Dump manifest file at _PATH_ in text format. This is only useful when
-    debugging ccache and its behavior.
-
-*`-k`* _KEY_, *`--get-config`* _KEY_::
-
-    Print the value of configuration option _KEY_. See
-    <<_configuration,CONFIGURATION>> for more information.
-
-*`--hash-file`* _PATH_::
-
-    Print the hash (160 bit BLAKE3) of the file at _PATH_. This is only useful
-    when debugging ccache and its behavior.
-
 *`-h`*, *`--help`*::
 
     Print an options summary page.
@@ -123,38 +112,33 @@ compiler options apply and you should refer to the compiler's documentation.
     stored in a configuration file in the cache directory and applies to all
     future compilations.
 
-*`--print-stats`*::
+*`-X`* _LEVEL_, *`--recompress`* _LEVEL_::
 
-    Print statistics counter IDs and corresponding values machine-parsable
-    (tab-separated) format.
+    Recompress the cache using compression level _LEVEL_. The level can be an
+    integer, with the same semantics as the
+    <<config_compression_level,*compression_level*>> configuration setting), or
+    the special value *uncompressed* for no compression. See
+    <<_cache_compression,CACHE COMPRESSION>> for more information. This can
+    potentionally take a long time since all files in the cache need to be
+    visited. Only files that are currently compressed with a different level
+    than _LEVEL_ will be recompressed.
 
 *`-o`* _KEY=VALUE_, *`--set-config`* _KEY_=_VALUE_::
 
     Set configuration option _KEY_ to _VALUE_. See
     <<_configuration,CONFIGURATION>> for more information.
 
-*`-p`*, *`--show-config`*::
-
-    Print current configuration options and from where they originate
-    (environment variable, configuration file or compile-time default) in
-    human-readable format.
-
 *`-x`*, *`--show-compression`*::
 
     Print cache compression statistics. See <<_cache_compression,CACHE
     COMPRESSION>> for more information. This can potentionally take a long time
     since all files in the cache need to be visited.
 
-*`-X`* _LEVEL_, *`--recompress`* _LEVEL_::
+*`-p`*, *`--show-config`*::
 
-    Recompress the cache using compression level _LEVEL_. The level can be an
-    integer, with the same semantics as the
-    <<config_compression_level,*compression_level*>> configuration setting), or
-    the special value *uncompressed* for no compression. See
-    <<_cache_compression,CACHE COMPRESSION>> for more information. This can
-    potentionally take a long time since all files in the cache need to be
-    visited. Only files that are currently compressed with a different level
-    than _LEVEL_ will be recompressed.
+    Print current configuration options and from where they originate
+    (environment variable, configuration file or compile-time default) in
+    human-readable format.
 
 *`-s`*, *`--show-stats`*::
 
@@ -170,6 +154,31 @@ compiler options apply and you should refer to the compiler's documentation.
     Zero the cache statistics (but not the configuration options).
 
 
+Options for scripting or debugging
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+*`--dump-manifest`* _PATH_::
+
+    Dump manifest file at _PATH_ in text format. This is only useful when
+    debugging ccache and its behavior.
+
+*`-k`* _KEY_, *`--get-config`* _KEY_::
+
+    Print the value of configuration option _KEY_. See
+    <<_configuration,CONFIGURATION>> for more information.
+
+*`--hash-file`* _PATH_::
+
+    Print the hash (160 bit BLAKE3) of the file at _PATH_. This is only useful
+    when debugging ccache and its behavior.
+
+*`--print-stats`*::
+
+    Print statistics counter IDs and corresponding values machine-parsable
+    (tab-separated) format.
+
+
+
 Extra options
 -------------
 
diff --git a/src/ccache.cpp b/src/ccache.cpp
index 8ca078644..67a3c2fc2 100644
--- a/src/ccache.cpp
+++ b/src/ccache.cpp
@@ -92,6 +92,7 @@ Common options:
                               and Ki, Mi, Gi, Ti (binary); default suffix: G
     -X, --recompress LEVEL    recompress the cache to LEVEL (integer level or
                               "uncompressed")
+    -o, --set-config KEY=VAL  set configuration item KEY to value VAL
     -x, --show-compression    show compression statistics
     -p, --show-config         show current configuration options in
                               human-readable format
@@ -109,7 +110,6 @@ Options for scripting or debugging:
                               PATH
         --print-stats         print statistics counter IDs and corresponding
                               values in machine-parsable format
-    -o, --set-config KEY=VAL  set configuration item KEY to value VAL
 
 See also <https://ccache.dev>.
 )";