]> git.ipfire.org Git - thirdparty/ccache.git/commitdiff
doc: Move description of preprocessor mode before direct mode
authorJoel Rosdahl <joel@rosdahl.net>
Wed, 5 Feb 2020 19:01:22 +0000 (20:01 +0100)
committerJoel Rosdahl <joel@rosdahl.net>
Wed, 5 Feb 2020 19:23:13 +0000 (20:23 +0100)
This way the depend mode is documented directly after the direct mode
which makes more sense since they are related.

doc/MANUAL.adoc

index d9db0a06f9583358c1773e52a1ad8a1b0440ebee..639c874b263940bdb31f8e71824bd2caf14e9092 100644 (file)
@@ -941,10 +941,10 @@ algorithm, to detect corruption.
 ccache has two ways of gathering information used to look up results in the
 cache:
 
-* the *direct mode*, where ccache hashes the source code and include files
-  directly
 * the *preprocessor mode*, where ccache runs the preprocessor on the source
   code and hashes the result
+* the *direct mode*, where ccache hashes the source code and include files
+  directly
 
 The direct mode is generally faster since running the preprocessor has some
 overhead.
@@ -973,6 +973,21 @@ The following information is always included in the hash:
   <<config_extra_file_to_hash,*extra_files_to_hash*>> setting (if any)
 
 
+The preprocessor mode
+~~~~~~~~~~~~~~~~~~~~~
+
+In the preprocessor mode, the hash is formed of the common information and:
+
+* the preprocessor output from running the compiler with *-E*
+* the command line options except options that affect include files (*-I*,
+  *-include*, *-D*, etc; the theory is that these options will change the
+  preprocessor output if they have any effect at all)
+* any standard error output generated by the preprocessor
+
+Based on the hash, the cached compilation result can be looked up directly in
+the cache.
+
+
 The direct mode
 ~~~~~~~~~~~~~~~
 
@@ -1018,21 +1033,6 @@ The direct mode will be disabled if any of the following holds:
 * the string `__TIME__` is present in the source code
 
 
-The preprocessor mode
-~~~~~~~~~~~~~~~~~~~~~
-
-In the preprocessor mode, the hash is formed of the common information and:
-
-* the preprocessor output from running the compiler with *-E*
-* the command line options except options that affect include files (*-I*,
-  *-include*, *-D*, etc; the theory is that these options will change the
-  preprocessor output if they have any effect at all)
-* any standard error output generated by the preprocessor
-
-Based on the hash, the cached compilation result can be looked up directly in
-the cache.
-
-
 The depend mode
 ~~~~~~~~~~~~~~~