projects / platform / upstream / ccache.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Imported Upstream version 3.7.3
[platform/upstream/ccache.git] / doc / MANUAL.html
diff --git a/doc/MANUAL.html b/doc/MANUAL.html
index 7f3bc98..36b175c 100644 (file)
--- a/doc/MANUAL.html
+++ b/doc/MANUAL.html
@@ -735,7 +735,7 @@ asciidoc.install(2);
 <body class="article">\r
 <div id="header">\r
 <h1>CCACHE(1)</h1>\r
-<span id="revnumber">version 3.6</span>\r
+<span id="revnumber">version 3.7.3</span>\r
 <div id="toc">
   <div id="toctitle">Table of Contents</div>
   <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
@@ -907,13 +907,30 @@ compiler options apply and you should refer to the compiler&#8217;s documentatio
 </p>\r
 </dd>\r
 <dt class="hdlist1">\r
-<strong><code>-F, --max-files</code></strong>=<em>N</em>\r
+<strong><code>--dump-manifest</code></strong>=<em>PATH</em>\r
 </dt>\r
 <dd>\r
 <p>\r
-    Set the maximum number of files allowed in the cache. Use 0 for no limit.\r
-    The value is stored in a configuration file in the cache directory and\r
-    applies to all future compilations.\r
+    Dump manifest file at PATH in text format. This is only useful when\r
+    debugging ccache and its behavior.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+<strong><code>-k, --get-config</code></strong>=<em>KEY</em>\r
+</dt>\r
+<dd>\r
+<p>\r
+    Print the value of configuration option <em>KEY</em>. See\r
+    <a href="#_configuration">CONFIGURATION</a> for more information.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+<strong><code>--hash-file</code></strong>=<em>PATH</em>\r
+</dt>\r
+<dd>\r
+<p>\r
+    Print the hash (in format <code>&lt;MD4&gt;-&lt;size&gt;</code>) of the file at PATH. This is only\r
+    useful when debugging ccache and its behavior.\r
 </p>\r
 </dd>\r
 <dt class="hdlist1">\r
@@ -925,6 +942,16 @@ compiler options apply and you should refer to the compiler&#8217;s documentatio
 </p>\r
 </dd>\r
 <dt class="hdlist1">\r
+<strong><code>-F, --max-files</code></strong>=<em>N</em>\r
+</dt>\r
+<dd>\r
+<p>\r
+    Set the maximum number of files allowed in the cache. Use 0 for no limit.\r
+    The value is stored in a configuration file in the cache directory and\r
+    applies to all future compilations.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
 <strong><code>-M, --max-size</code></strong>=<em>SIZE</em>\r
 </dt>\r
 <dd>\r
@@ -937,21 +964,31 @@ compiler options apply and you should refer to the compiler&#8217;s documentatio
 </p>\r
 </dd>\r
 <dt class="hdlist1">\r
+<strong><code>--print-stats</code></strong>\r
+</dt>\r
+<dd>\r
+<p>\r
+    Print statistics counter IDs and corresponding values machine-parsable\r
+    (tab-separated) format.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
 <strong><code>-o, --set-config</code></strong>=<em>KEY=VALUE</em>\r
 </dt>\r
 <dd>\r
 <p>\r
-    Set configuration <em>KEY</em> to <em>VALUE</em>. See <a href="#_configuration">CONFIGURATION</a>\r
-    for more information.\r
+    Set configuration option <em>KEY</em> to <em>VALUE</em>. See\r
+    <a href="#_configuration">CONFIGURATION</a> for more information.\r
 </p>\r
 </dd>\r
 <dt class="hdlist1">\r
-<strong><code>-p, --print-config</code></strong>\r
+<strong><code>-p, --show-config</code></strong>\r
 </dt>\r
 <dd>\r
 <p>\r
     Print current configuration options and from where they originate\r
-    (environment variable, configuration file or compile-time default).\r
+    (environment variable, configuration file or compile-time default) in\r
+    human-readable format.\r
 </p>\r
 </dd>\r
 <dt class="hdlist1">\r
@@ -959,7 +996,8 @@ compiler options apply and you should refer to the compiler&#8217;s documentatio
 </dt>\r
 <dd>\r
 <p>\r
-    Print the current statistics summary for the cache.\r
+    Print a summary of configuration and statistics counters in human-readable\r
+    format.\r
 </p>\r
 </dd>\r
 <dt class="hdlist1">\r
@@ -2125,8 +2163,15 @@ The cache hit rate will likely be lower since any change to compiler options
 </li>\r
 <li>\r
 <p>\r
-The manifest entries will include system header files as well, thus slowing\r
-  down cache hits slightly.\r
+If -MD is used, the manifest entries will include system header files as\r
+  well, thus slowing down cache hits slightly, just as using -MD slows down\r
+  make.\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+If -MMD is used, the manifest entries will not include system header files,\r
+  which means ccache will ignore changes in them.\r
 </p>\r
 </li>\r
 </ul></div>\r
@@ -2329,8 +2374,10 @@ You must either:
 <div class="ulist"><ul>\r
 <li>\r
 <p>\r
-use the <strong>-include</strong> compiler option to include the precompiled header\r
-   (i.e., don&#8217;t use <strong>#include</strong> in the source code to include the header); or\r
+use the <strong>-include</strong> compiler option to include the precompiled header (i.e.,\r
+   don&#8217;t use <strong>#include</strong> in the source code to include the header; the filename\r
+   itself must be sufficient to find the header, i.e. <strong>-I</strong> paths are not\r
+   searched); or\r
 </p>\r
 </li>\r
 <li>\r
@@ -2341,7 +2388,8 @@ use the <strong>-include</strong> compiler option to include the precompiled hea
 </li>\r
 <li>\r
 <p>\r
-add the <strong>-fpch-preprocess</strong> compiler option when compiling.\r
+(for the GCC compiler) add the <strong>-fpch-preprocess</strong> compiler option when\r
+   compiling.\r
 </p>\r
 </li>\r
 </ul></div>\r
@@ -2511,9 +2559,10 @@ If ccache guesses that the compiler may emit colored warnings, then a
 <div class="sect2">\r
 <h3 id="_general">General</h3>\r
 <div class="paragraph"><p>A general tip for getting information about what ccache is doing is to enable\r
-debug logging by setting <strong>log_file</strong>. The log contains executed commands,\r
-important decisions that ccache makes, read and written files, etc. Another way\r
-of keeping track of what is happening is to check the output of <strong>ccache -s</strong>.</p></div>\r
+debug logging by setting the configuration option <strong>debug</strong> (or the environment\r
+variable <strong>CCACHE_DEBUG</strong>); see <a href="#_cache_debugging">debugging</a> for more\r
+information. Another way of keeping track of what is happening is to check the\r
+output of <strong>ccache -s</strong>.</p></div>\r
 </div>\r
 <div class="sect2">\r
 <h3 id="_performance">Performance</h3>\r
@@ -2682,7 +2731,7 @@ case, please report it.</p></div>
 <h2 id="_more_information">More information</h2>\r
 <div class="sectionbody">\r
 <div class="paragraph"><p>Credits, mailing list information, bug reporting instructions, source code,\r
-etc, can be found on ccache&#8217;s web site: <a href="https://ccache.samba.org">https://ccache.samba.org</a>.</p></div>\r
+etc, can be found on ccache&#8217;s web site: <a href="https://ccache.dev">https://ccache.dev</a>.</p></div>\r
 </div>\r
 </div>\r
 <div class="sect1">\r
@@ -2690,16 +2739,16 @@ etc, can be found on ccache&#8217;s web site: <a href="https://ccache.samba.org"
 <div class="sectionbody">\r
 <div class="paragraph"><p>ccache was originally written by Andrew Tridgell and is currently developed and\r
 maintained by Joel Rosdahl. See AUTHORS.txt or AUTHORS.html and\r
-<a href="https://ccache.samba.org/credits.html">https://ccache.samba.org/credits.html</a> for a list of contributors.</p></div>\r
+<a href="https://ccache.dev/credits.html">https://ccache.dev/credits.html</a> for a list of contributors.</p></div>\r
 </div>\r
 </div>\r
 </div>\r
 <div id="footnotes"><hr /></div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Version 3.6<br />\r
+Version 3.7.3<br />\r
 Last updated\r
- 2019-01-13 21:38:14 CET\r
+ 2019-08-17 22:37:25 CEST\r
 </div>\r
 </div>\r
 </body>\r
Domain: System / Base;