From faf7aaccf9b92f032cb934456c7ab8861c41a96a Mon Sep 17 00:00:00 2001 From: Joel Rosdahl Date: Wed, 5 Feb 2020 20:01:22 +0100 Subject: [PATCH] doc: Move description of preprocessor mode before direct mode This way the depend mode is documented directly after the direct mode which makes more sense since they are related. --- doc/MANUAL.adoc | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/doc/MANUAL.adoc b/doc/MANUAL.adoc index d9db0a06f..639c874b2 100644 --- a/doc/MANUAL.adoc +++ b/doc/MANUAL.adoc @@ -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: <> 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 ~~~~~~~~~~~~~~~ -- 2.47.2