From a23ba28a7462030438f5f25b8014d82bd55cbe1c Mon Sep 17 00:00:00 2001 From: Joel Rosdahl Date: Thu, 13 May 2010 12:26:57 +0200 Subject: [PATCH] Minor updates to the manual --- manual.txt | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/manual.txt b/manual.txt index cc4fab547..bfd0090e7 100644 --- a/manual.txt +++ b/manual.txt @@ -160,10 +160,10 @@ cases you won't need any of these as the defaults will be fine. *CCACHE_BASEDIR*:: - If you set the environment variable *CCACHE_BASEDIR* to an absolute path, - ccache rewrites absolute paths into relative paths before computing the - hash that identifies the compilation, but only for paths under the - specified directory. See the discussion under + If you set the environment variable *CCACHE_BASEDIR* to an absolute path to + a directory, ccache rewrites absolute paths into relative paths before + computing the hash that identifies the compilation, but only for paths + under the specified directory. See the discussion under <<_compiling_in_different_directories,COMPILING IN DIFFERENT DIRECTORIES>>. *CCACHE_CC*:: @@ -421,8 +421,8 @@ In the preprocessor mode, the hash is formed of: * 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) -* the real compiler's size and modification time (unless - *CCACHE_COMPILERCHECK* says something else) +* the real compiler's size and modification time (unless CCACHE_COMPILERCHECK* + *says something else) * any standard error output generated by the preprocessor Based on the hash, the cached compilation result can be looked up directly in @@ -448,13 +448,13 @@ This means that if you compile the same code in different locations, you can't share compilation results between the different build directories since you get cache misses because of the absolute build directory paths that are part of the hash. To mitigate this problem, you can specify a ``base directory'' by setting -the *CCACHE_BASEDIR* variable to an absolute path. ccache will then rewrite -absolute paths that are under the base directory (i.e., paths that have the -base directory as a prefix) to relative paths when constructing the hash. The -typical path to use as base directory is your home directory or another -directory that is a parent of your build directories. (Don't use +/+ as the -base directory since that will make ccache also rewrite paths to system header -files, which doesn't gain anything.) +the *CCACHE_BASEDIR* variable to an absolute path to the directory. ccache will +then rewrite absolute paths that are under the base directory (i.e., paths that +have the base directory as a prefix) to relative paths when constructing the +hash. A typical path to use as the base directory is your home directory or +another directory that is a parent of your build directories. (Don't use +/+ as +the base directory since that will make ccache also rewrite paths to system +header files, which doesn't gain anything.) The drawbacks of using *CCACHE_BASEDIR* are: -- 2.47.3