From 62f7683b15d3983c52833d6cb429f675e0c68b7e Mon Sep 17 00:00:00 2001 From: Joel Rosdahl Date: Thu, 5 Nov 2009 23:20:48 +0100 Subject: [PATCH] Resync ccache.yo with ccache.1 --- ccache.yo | 76 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 41 insertions(+), 35 deletions(-) diff --git a/ccache.yo b/ccache.yo index c340891..d4f1a80 100644 --- a/ccache.yo +++ b/ccache.yo @@ -20,14 +20,14 @@ manpagesection(OPTIONS SUMMARY) Here is a summary of the options to ccache. verb( --s show statistics summary --z zero statistics --c run a cache cleanup --C clear the cache completely --F set maximum files in cache --M set maximum size of cache (use G, M or K) --h this help page --V print version number +-s, --show-stats show statistics summary +-z, --zero-stats zero statistics +-c, --cleanup run a cache cleanup +-C, --clear clear the cache completely +-F , --max-files= set maximum files in cache +-M , --max-size= set maximum size of cache (use G, M or K) +-h, --help this help page +-V, --version print version number ) manpageoptions() @@ -38,35 +38,38 @@ normal compiler options apply and you should refer to your compilers documentation. startdit() -dit(bf(-h)) Print a options summary page +dit(bf(-h, --help)) Print a options summary page -dit(bf(-s)) Print the current statistics summary for the cache. The -statistics are stored spread across the subdirectories of the -cache. Using "ccache -s" adds up the statistics across all +dit(bf(-s, --show-stats)) Print the current statistics summary for the +cache. The statistics are stored spread across the subdirectories of +the cache. Using "ccache -s" adds up the statistics across all subdirectories and prints the totals. -dit(bf(-z)) Zero the cache statistics. +dit(bf(-z, --zero-stats)) Zero the cache statistics. -dit(bf(-V)) Print the ccache version number +dit(bf(-V, --version)) Print the ccache version number -dit(bf(-c)) Clean the cache and re-calculate the cache file count and -size totals. Normally the -c option should not be necessary as ccache -keeps the cache below the specified limits at runtime and keeps -statistics up to date on each compile. This option is mostly useful -if you manually modify the cache contents or believe that the cache -size statistics may be inaccurate. +dit(bf(-c, --cleanup)) Clean the cache and re-calculate the cache file +count and size totals. Normally the -c option should not be necessary +as ccache keeps the cache below the specified limits at runtime and +keeps statistics up to date on each compile. This option is mostly +useful if you manually modify the cache contents or believe that the +cache size statistics may be inaccurate. -dit(bf(-C)) Clear the entire cache, removing all cached files. +dit(bf(-C, --clear)) Clear the entire cache, removing all cached +files. -dit(bf(-F maxfiles)) This sets the maximum number of files allowed in -the cache. The value is stored inside the cache directory and applies -to all future compiles. Due to the way the value is stored the actual -value used is always rounded down to the nearest multiple of 16. +dit(bf(-F , --max-files=)) This sets the maximum +number of files allowed in the cache. The value is stored inside the +cache directory and applies to all future compiles. Due to the way the +value is stored the actual value used is always rounded down to the +nearest multiple of 16. -dit(bf(-M maxsize)) This sets the maximum cache size. You can specify -a value in gigabytes, megabytes or kilobytes by appending a G, M or K -to the value. The default is gigabytes. The actual value stored is -rounded down to the nearest multiple of 16 kilobytes. +dit(bf(-M , --max-size=)) This sets the maximum +cache size. You can specify a value in gigabytes, megabytes or +kilobytes by appending a G, M or K to the value. The default is +gigabytes. The actual value stored is rounded down to the nearest +multiple of 16 kilobytes. enddit() @@ -209,6 +212,15 @@ 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_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, +where even though the compiler's size or modification time has changed +you can safely use the cached objects (e.g. if as part of your build +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 @@ -345,12 +357,6 @@ it() ccache can handle a much wider ranger of compiler options it() ccache avoids a double call to cpp on a cache miss ) -manpagesection(BUGS) - -When the cache is stored on an NFS filesystem, the filesystem must be -exported with the bf(no_subtree_check) option to make renames between -directories reliable. - manpagesection(CREDITS) Thanks to the following people for their contributions to ccache