]> git.ipfire.org Git - thirdparty/ccache.git/commitdiff
Don't use uppercase titles in the manual
authorJoel Rosdahl <joel@rosdahl.net>
Sat, 19 Jun 2010 16:52:28 +0000 (18:52 +0200)
committerJoel Rosdahl <joel@rosdahl.net>
Sat, 19 Jun 2010 16:52:28 +0000 (18:52 +0200)
manual.txt

index 1af3ce54ac1d7265f72f5374f185c9bdeecd131a..3c504a95ae019a5ec2521da38d4e280aa50d271e 100644 (file)
@@ -2,13 +2,13 @@ CCACHE(1)
 =========
 
 
-NAME
+Name
 ----
 
 ccache - a fast C/C++ compiler cache
 
 
-SYNOPSIS
+Synopsis
 --------
 
 [verse]
@@ -17,7 +17,7 @@ SYNOPSIS
 'compiler' ['compiler options']                   (via symbolic link)
 
 
-DESCRIPTION
+Description
 -----------
 
 ccache is a compiler cache. It speeds up recompilation by caching the result of
@@ -31,7 +31,7 @@ goal are listed under <<_bugs,BUGS>>. If you ever discover an undocumented case
 where ccache changes the output of your compiler, please let us know.
 
 
-FEATURES
+Features
 ~~~~~~~~
 
 * Keeps statistics on hits/misses.
@@ -43,7 +43,7 @@ FEATURES
 * Optionally compresses files in the cache to reduce disk space.
 
 
-LIMITATIONS
+Limitations
 ~~~~~~~~~~~
 
 * Only knows how to cache the compilation of a single
@@ -55,7 +55,7 @@ LIMITATIONS
   will silently fall back to running the real compiler.
 
 
-RUN MODES
+Run modes
 ---------
 
 There are two ways to use ccache. You can either prefix your compilation
@@ -83,7 +83,7 @@ NOTE: Do not use a hard link, use a symbolic link. A hard link will cause
 ``interesting'' problems.
 
 
-OPTIONS
+Options
 -------
 
 These options only apply when you invoke ccache as ``ccache''. When invoked as
@@ -135,7 +135,7 @@ compiler options apply and you should refer to the compiler's documentation.
     Zero the cache statistics (but not the configured limits).
 
 
-EXTRA OPTIONS
+Extra options
 -------------
 
 When run as a compiler, ccache usually just takes the same command line options
@@ -153,7 +153,7 @@ using *--ccache-skip* you can force an option to not be treated as an input
 file name and instead be passed along to the compiler as a command line option.
 
 
-ENVIRONMENT VARIABLES
+Environment variables
 ---------------------
 
 ccache uses a number of environment variables to control operation. In most
@@ -340,11 +340,11 @@ cases you won't need any of these as the defaults will be fine.
     hash, so cached compilations with *CCACHE_UNIFY* set cannot be used when
     *CCACHE_UNIFY* is not set and vice versa. The reason the unifier is off by
     default is that it can give incorrect line number information in compiler
-    warning messages. *Note*: Enabling the unifier implies turning off the
-    direct mode.
+    warning messages. Also note that enabling the unifier implies turning off
+    the direct mode.
 
 
-CACHE SIZE MANAGEMENT
+Cache size management
 ---------------------
 
 By default ccache has a one gigabyte limit on the total size of files in the
@@ -354,7 +354,7 @@ to see the cache size and the currently configured limits (in addition to other
 various statistics).
 
 
-CACHE COMPRESSION
+Cache compression
 -----------------
 
 ccache can optionally compress all files it puts into the cache using the
@@ -364,7 +364,7 @@ You can turn on compression by setting the *CCACHE_COMPRESS* environment
 variable.
 
 
-HOW CCACHE WORKS
+How ccache works
 ----------------
 
 The basic idea is to detect when you are compiling exactly the same code a
@@ -383,7 +383,7 @@ ccache has two ways of doing the detection:
 * the *preprocessor mode* (hashes output from the preprocessor)
 
 
-THE DIRECT MODE
+The direct mode
 ~~~~~~~~~~~~~~~
 
 In the direct mode, the hash is formed of:
@@ -425,7 +425,7 @@ The direct mode will be disabled if any of the following holds:
   the source code
 
 
-THE PREPROCESSOR MODE
+The preprocessor mode
 ~~~~~~~~~~~~~~~~~~~~~
 
 In the preprocessor mode, the hash is formed of:
@@ -434,15 +434,15 @@ 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
 the cache.
 
 
-COMPILING IN DIFFERENT DIRECTORIES
+Compiling in different directories
 ----------------------------------
 
 Some information included in the hash that identifies a unique compilation may
@@ -480,7 +480,7 @@ The drawbacks of using *CCACHE_BASEDIR* are:
   ``cd'' command in GDB.
 
 
-SHARING A CACHE
+Sharing a cache
 ---------------
 
 A group of developers can increase the cache hit rate by sharing a cache
@@ -509,7 +509,7 @@ You may also want to make sure that the developers have *CCACHE_BASEDIR* set
 appropriately, as discussed in the previous section.
 
 
-SHARING A CACHE ON NFS
+Sharing a cache on NFS
 ----------------------
 
 It is possible to put the cache directory on an NFS filesystem (or similar
@@ -523,7 +523,7 @@ A tip is to set *CCACHE_TEMPDIR* to a directory on the local host to avoid NFS
 traffic for temporary files.
 
 
-USING CCACHE WITH DISTCC
+Using ccache with distcc
 ------------------------
 
 ``distcc'' is a very useful program for distributing compilation across a range
@@ -543,7 +543,7 @@ that compiler upgrades will not be detected properly and that the cached
 results will not be shared between compilations with and without distcc.
 
 
-BUGS
+Bugs
 ----
 
 * ccache doesn't handle the GNU Assembler's *.incbin* directive correctly. This
@@ -555,10 +555,10 @@ BUGS
 
 
 
-TROUBLESHOOTING
+Troubleshooting
 ---------------
 
-GENERAL
+General
 ~~~~~~~
 
 A general tip for getting information about what ccache is doing is to enable
@@ -567,7 +567,7 @@ important decisions that ccache makes, read and written files, etc. Another way
 of keeping track of what is happening is to check the output of *ccache -s*.
 
 
-PERFORMANCE
+Performance
 ~~~~~~~~~~~
 
 ccache has been written to perform well out of the box, but sometimes you may
@@ -643,7 +643,7 @@ problems and what may be done to increase the hit rate:
   and check which option was rejected.
 
 
-ERRORS WHEN COMPILING WITH CCACHE
+Errors when compiling with ccache
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 If compilation doesn't work with ccache, but it works without it, one possible
@@ -652,7 +652,7 @@ workaround that may work is to set *CCACHE_CPP2*. This will make cache misses
 slower, though, so it is better to find and fix the root cause.
 
 
-CORRUPT OBJECT FILES
+Corrupt object files
 ~~~~~~~~~~~~~~~~~~~~
 
 It should be noted that ccache is susceptible to general storage problems. If a
@@ -669,14 +669,14 @@ reproducibly. That doesn't mean it can't happen, so if you find a repeatable
 case, please report it.
 
 
-MORE INFORMATION
+More information
 ----------------
 
 Credits, mailing list information, bug reporting instructions, source code,
 etc, can be found on ccache's web site: <http://ccache.samba.org>.
 
 
-AUTHOR
+Author
 ------
 
 ccache was originally written by Andrew Tridgell and is currently maintained by