Sort environment variable documentation entries

diff --git a/ccache.yo b/ccache.yo
index 2f2a034c11e7cceac51a032ab7e836cc897af7cf..151c4677ceeeab0b2abc17d1b1fb2ead226be3b1 100644 (file)
--- a/ccache.yo
+++ b/ccache.yo
@@ -124,45 +124,10 @@ most cases you won't need any of these as the defaults will be fine.
 
 startdit()
 
-dit(bf(CCACHE_DIR)) the CCACHE_DIR environment variable specifies
-where ccache will keep its cached compiler output. The default is
-"$HOME/.ccache".
-
-dit(bf(CCACHE_TEMPDIR)) the CCACHE_TEMPDIR environment variable specifies
-where ccache will put temporary files. The default is
-CCACHE_DIR/tmp. Note that the CCACHE_TEMPDIR path must be on the same
-filesystem as the CCACHE_DIR path, so that renames of files between
-the two directories can work.
-
-dit(bf(CCACHE_LOGFILE)) If you set the CCACHE_LOGFILE environment
-variable then ccache will write some log information on cache hits
-and misses in that file. This is useful for tracking down problems.
-
-dit(bf(CCACHE_PATH)) You can optionally set CCACHE_PATH to a colon
-separated path where ccache will look for the real compilers. If you
-don't do this then ccache will look for the first executable matching
-the compiler name in the normal PATH that isn't a symbolic link to
-ccache itself.
-
 dit(bf(CCACHE_CC)) You can optionally set CCACHE_CC to force the name
 of the compiler to use. If you don't do this then ccache works it out
 from the command line.
 
-dit(bf(CCACHE_PREFIX)) This option adds a prefix to the command line
-that ccache runs when invoking the compiler. Also see the section
-below on using ccache with distcc.
-
-dit(bf(CCACHE_DISABLE)) If you set the environment variable
-CCACHE_DISABLE then ccache will just call the real compiler,
-bypassing the cache completely.
-
-dit(bf(CCACHE_READONLY)) the CCACHE_READONLY environment variable
-tells ccache to attempt to use existing cached object files, but not
-to try to add anything new to the cache. If you are using this because
-your CCACHE_DIR is read-only, then you may find that you also need to
-set CCACHE_TEMPDIR as otherwise ccache will fail to create the
-temporary files.
-
 dit(bf(CCACHE_CPP2)) If you set the environment variable CCACHE_CPP2
 then ccache will not use the optimisation of avoiding the 2nd call to
 the preprocessor by compiling the preprocessed output that was used
@@ -172,21 +137,25 @@ will have problems with the intermediate filename extensions used in
 this optimisation, in which case this option could allow ccache to be
 used.
 
-dit(bf(CCACHE_NOCOMPRESS)) If you set the environment variable
-CCACHE_NOCOMPRESS then there is no compression used on files that go
-into the cache. However, this setting has no effect on how files are
-retrieved from the cache, compressed results will still be usable.
+dit(bf(CCACHE_DIR)) the CCACHE_DIR environment variable specifies
+where ccache will keep its cached compiler output. The default is
+"$HOME/.ccache".
 
-dit(bf(CCACHE_NODIRECT)) If you set the environment variable
-CCACHE_NODIRECT then ccache will not use the direct mode.
+dit(bf(CCACHE_DISABLE)) If you set the environment variable
+CCACHE_DISABLE then ccache will just call the real compiler,
+bypassing the cache completely.
 
-dit(bf(CCACHE_NOSTATS)) If you set the environment variable
-CCACHE_NOSTATS then ccache will not update the statistics files on
-each compile.
+dit(bf(CCACHE_EXTENSION)) Normally ccache tries to automatically
+determine the extension to use for intermediate C preprocessor files
+based on the type of file being compiled. Unfortunately this sometimes
+doesn't work, for example when using the aCC compiler on HP-UX. On
+systems like this you can use the CCACHE_EXTENSION option to override
+the default. On HP-UX set this environment variable to "i" if you use
+the aCC compiler.
 
-dit(bf(CCACHE_NLEVELS)) The environment variable CCACHE_NLEVELS allows
-you to choose the number of levels of hash in the cache directory. The
-default is 2. The minimum is 1 and the maximum is 8.
+dit(bf(CCACHE_LOGFILE)) If you set the CCACHE_LOGFILE environment
+variable then ccache will write some log information on cache hits
+and misses in that file. This is useful for tracking down problems.
 
 dit(bf(CCACHE_HARDLINK)) If you set the environment variable
 CCACHE_HARDLINK then ccache will attempt to use hard links from the
@@ -196,15 +165,10 @@ file copy. Using hard links is faster, but can confuse programs like
 compressed cache files. This means that you typically also should set
 the CCACHE_NOCOMPRESS variable if you want to use hard links.
 
-dit(bf(CCACHE_RECACHE)) This forces ccache to not use any cached
-results, even if it finds them. New results are still cached, but
-existing cache entries are ignored.
-
-dit(bf(CCACHE_UMASK)) This sets the umask for ccache and all child
-processes (such as the compiler). This is mostly useful when you wish
-to share your cache with other users. Note that this also affects the
-file permissions set on the object files created from your
-compilations.
+dit(bf(CCACHE_HASH_COMPILER)) This tells ccache to hash binary of the
+compiler instead of hashing just its size and mtime. This is very
+slightly slower, but makes copes better with compiler upgrades during
+a build bootstrapping process.
 
 dit(bf(CCACHE_HASHDIR)) This tells ccache to hash the current working
 directory when calculating the hash that is used to distinguish two
@@ -216,6 +180,18 @@ incorrect setting of this debug info rarely causes problems. If you
 strike problems with gdb not using the correct directory then enable
 this option.
 
+dit(bf(CCACHE_NLEVELS)) The environment variable CCACHE_NLEVELS allows
+you to choose the number of levels of hash in the cache directory. The
+default is 2. The minimum is 1 and the maximum is 8.
+
+dit(bf(CCACHE_NOCOMPRESS)) If you set the environment variable
+CCACHE_NOCOMPRESS then there is no compression used on files that go
+into the cache. However, this setting has no effect on how files are
+retrieved from the cache, compressed results will still be usable.
+
+dit(bf(CCACHE_NODIRECT)) If you set the environment variable
+CCACHE_NODIRECT then ccache will not use the direct mode.
+
 dit(bf(CCACHE_NOHASH_SIZE_MTIME)) This tells ccache to not hash the
 real compiler's size and modification time. Normally this is the
 mechanism to detect compiler upgrades. There are situations, however,
@@ -225,10 +201,42 @@ system the compiler is built as well and the compiler's source has not
 changed; or if the compiler has only changes that do not affect code
 generation). Use this feature only if you know what you are doing.
 
-dit(bf(CCACHE_HASH_COMPILER)) This tells ccache to hash binary of the
-compiler instead of hashing just its size and mtime. This is very
-slightly slower, but makes copes better with compiler upgrades during
-a build bootstrapping process.
+dit(bf(CCACHE_NOSTATS)) If you set the environment variable
+CCACHE_NOSTATS then ccache will not update the statistics files on
+each compile.
+
+dit(bf(CCACHE_PATH)) You can optionally set CCACHE_PATH to a colon
+separated path where ccache will look for the real compilers. If you
+don't do this then ccache will look for the first executable matching
+the compiler name in the normal PATH that isn't a symbolic link to
+ccache itself.
+
+dit(bf(CCACHE_PREFIX)) This option adds a prefix to the command line
+that ccache runs when invoking the compiler. Also see the section
+below on using ccache with distcc.
+
+dit(bf(CCACHE_READONLY)) the CCACHE_READONLY environment variable
+tells ccache to attempt to use existing cached object files, but not
+to try to add anything new to the cache. If you are using this because
+your CCACHE_DIR is read-only, then you may find that you also need to
+set CCACHE_TEMPDIR as otherwise ccache will fail to create the
+temporary files.
+
+dit(bf(CCACHE_RECACHE)) This forces ccache to not use any cached
+results, even if it finds them. New results are still cached, but
+existing cache entries are ignored.
+
+dit(bf(CCACHE_TEMPDIR)) the CCACHE_TEMPDIR environment variable specifies
+where ccache will put temporary files. The default is
+CCACHE_DIR/tmp. Note that the CCACHE_TEMPDIR path must be on the same
+filesystem as the CCACHE_DIR path, so that renames of files between
+the two directories can work.
+
+dit(bf(CCACHE_UMASK)) This sets the umask for ccache and all child
+processes (such as the compiler). This is mostly useful when you wish
+to share your cache with other users. Note that this also affects the
+file permissions set on the object files created from your
+compilations.
 
 dit(bf(CCACHE_UNIFY)) If you set the environment variable CCACHE_UNIFY
 then ccache will use the C/C++ unifier when hashing the preprocessor
@@ -243,14 +251,6 @@ by default is that it can give incorrect line number information in
 compiler warning messages. Enabling the unifier implies turning off
 the direct mode.
 
-dit(bf(CCACHE_EXTENSION)) Normally ccache tries to automatically
-determine the extension to use for intermediate C preprocessor files
-based on the type of file being compiled. Unfortunately this sometimes
-doesn't work, for example when using the aCC compiler on HP-UX. On
-systems like this you can use the CCACHE_EXTENSION option to override
-the default. On HP-UX set this environment variable to "i" if you use
-the aCC compiler.
-
 enddit()
 
 manpagesection(CACHE SIZE MANAGEMENT)