added docs for --ccache-skip

diff --git a/ccache.1 b/ccache.1
index 47783f59bac4a0b64b368d3853193fc4d1ab6f57..de6f8dc7ae3fbe111c0dce3e2b2a3f4a0246efb4 100644 (file)
--- a/ccache.1
+++ b/ccache.1
@@ -113,6 +113,24 @@ This will work as long as /usr/local/bin comes before the path to gcc
 Note! Do not use a hard link, use a symbolic link\&. A hardlink will
 cause "interesting" problems\&.
 .PP 
+.SH "EXTRA OPTIONS" 
+.PP 
+When run as a compiler front end ccache usually just takes the same
+command line options as the compiler you are using\&. The only exception
+to this is the option \&'--ccache-skip\&'\&. That option can be used to tell
+ccache that the next option is definately not a input filename, and
+should be passed along to the compiler as-is\&. 
+.PP 
+The reason this can be important is that ccache does need to parse the
+command line and determine what is an input filename and what is a
+compiler option, as it needs the input filename to determine the name
+of the resulting object file (among other things)\&. The heuristic
+ccache uses in this parse is that any string on the command line that
+exists as a file is treated as an input file name (usually a C
+file)\&. By 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\&.
+.PP 
 .SH "ENVIRONMENT VARIABLES" 
 .PP 
 ccache used a number of environment variables to control operation\&. In

diff --git a/ccache.yo b/ccache.yo
index aaab022e8693fe7449b51af7f2a4e3018fbd0087..64f665e954072b830b0ddb1d63e48852e5a31155 100644 (file)
--- a/ccache.yo
+++ b/ccache.yo
@@ -95,6 +95,24 @@ This will work as long as /usr/local/bin comes before the path to gcc
 Note! Do not use a hard link, use a symbolic link. A hardlink will
 cause "interesting" problems.
 
+manpagesection(EXTRA OPTIONS)
+
+When run as a compiler front end ccache usually just takes the same
+command line options as the compiler you are using. The only exception
+to this is the option '--ccache-skip'. That option can be used to tell
+ccache that the next option is definately not a input filename, and
+should be passed along to the compiler as-is. 
+
+The reason this can be important is that ccache does need to parse the
+command line and determine what is an input filename and what is a
+compiler option, as it needs the input filename to determine the name
+of the resulting object file (among other things). The heuristic
+ccache uses in this parse is that any string on the command line that
+exists as a file is treated as an input file name (usually a C
+file). By 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.
+
 manpagesection(ENVIRONMENT VARIABLES)
 
 ccache used a number of environment variables to control operation. In

diff --git a/web/ccache-man.html b/web/ccache-man.html
index 3c606f1378ad6767e037278a5cc739d9c40950bb..0c2ae19b50f73ac52e3ae5037a30098ad9c663c9 100644 (file)
--- a/web/ccache-man.html
+++ b/web/ccache-man.html
@@ -98,6 +98,22 @@ This will work as long as /usr/local/bin comes before the path to gcc
 "which gcc" to make sure that the correct link is being used.
 <p>Note! Do not use a hard link, use a symbolic link. A hardlink will
 cause "interesting" problems.
+<p><h2>EXTRA OPTIONS</h2>
+    
+<p>When run as a compiler front end ccache usually just takes the same
+command line options as the compiler you are using. The only exception
+to this is the option '--ccache-skip'. That option can be used to tell
+ccache that the next option is definately not a input filename, and
+should be passed along to the compiler as-is. 
+<p>The reason this can be important is that ccache does need to parse the
+command line and determine what is an input filename and what is a
+compiler option, as it needs the input filename to determine the name
+of the resulting object file (among other things). The heuristic
+ccache uses in this parse is that any string on the command line that
+exists as a file is treated as an input file name (usually a C
+file). By 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.
 <p><h2>ENVIRONMENT VARIABLES</h2>
     
 <p>ccache used a number of environment variables to control operation. In
@@ -173,9 +189,10 @@ the aCC compiler.
 <p></dl>
 <p><h2>CACHE SIZE MANAGEMENT</h2>
     
-<p>By default ccache has no limit on the cache size. You can set a limit
-using the "ccache -M" and "ccache -F" options, which set the size and
-number of files limits.
+<p>By default ccache has a one gigabyte limit on the cache size and no
+maximum number of files. You can set a different limit using the
+"ccache -M" and "ccache -F" options, which set the size and number of
+files limits.
 <p>When these limits are reached ccache will reduce the cache to 20%
 below the numbers you specified in order to avoid doing the cache
 clean operation too often.