From: Andrew Tridgell <tridge@samba.org>
Date: Sun, 16 Feb 2003 02:33:27 +0000 (+0100)
Subject: added docs on CCACHE_PREFIX and info on using ccache with distcc
X-Git-Tag: v2.2~6
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=6ed1a0c531dbfb965d0ebafa95b258b5e0d63b04;p=thirdparty%2Fccache.git

added docs on CCACHE_PREFIX and info on using ccache with distcc
---

diff --git a/ccache.1 b/ccache.1
index de6f8dc7a..7f4a1d0f8 100644
--- a/ccache.1
+++ b/ccache.1
@@ -159,6 +159,11 @@ 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\&.
 .IP 
+.IP "\fBCCACHE_PREFIX\fP" 
+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\&.
+.IP 
 .IP "\fBCCACHE_DISABLE\fP" 
 If you set the environment variable
 CCACHE_DISABLE then ccache will just call the real compiler,
@@ -267,6 +272,18 @@ compiler output that you would get without the cache\&. If you ever
 discover a case where ccache changes the output of your compiler then
 please let me know\&.
 .PP 
+.SH "USING CCACHE WITH DISTCC" 
+.PP 
+distcc is a very useful program for distributing compilation across a
+range of compiler servers\&. It is often useful to combine distcc with
+ccache, so that compiles that are done are sped up by distcc, but that
+ccache avoids the compile completely where possible\&.
+.PP 
+To use distcc with ccache I recommend using the CCACHE_PREFIX
+option\&. You just need to set the environment variable CCACHE_PREFIX to
+\&'distcc\&' and ccache will prefix the command line used with the
+compiler with the command \&'distcc\&'\&. 
+.PP 
 .SH "SHARING A CACHE" 
 .PP 
 A group of developers can increase the cache hit rate by sharing a
diff --git a/ccache.yo b/ccache.yo
index 64f665e95..8ff893f7e 100644
--- a/ccache.yo
+++ b/ccache.yo
@@ -138,6 +138,10 @@ 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.
@@ -236,6 +240,18 @@ compiler output that you would get without the cache. If you ever
 discover a case where ccache changes the output of your compiler then
 please let me know.
 
+manpagesection(USING CCACHE WITH DISTCC)
+
+distcc is a very useful program for distributing compilation across a
+range of compiler servers. It is often useful to combine distcc with
+ccache, so that compiles that are done are sped up by distcc, but that
+ccache avoids the compile completely where possible.
+
+To use distcc with ccache I recommend using the CCACHE_PREFIX
+option. You just need to set the environment variable CCACHE_PREFIX to
+'distcc' and ccache will prefix the command line used with the
+compiler with the command 'distcc'. 
+
 manpagesection(SHARING A CACHE)
 
 A group of developers can increase the cache hit rate by sharing a
diff --git a/web/ccache-man.html b/web/ccache-man.html
index 0c2ae19b5..f343cc189 100644
--- a/web/ccache-man.html
+++ b/web/ccache-man.html
@@ -133,6 +133,9 @@ ccache itself.
 <p><p></p><dt><strong><strong>CCACHE_CC</strong></strong><dd> 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.
+<p><p></p><dt><strong><strong>CCACHE_PREFIX</strong></strong><dd> 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.
 <p><p></p><dt><strong><strong>CCACHE_DISABLE</strong></strong><dd> If you set the environment variable
 CCACHE_DISABLE then ccache will just call the real compiler,
 bypassing the cache completely.
@@ -215,6 +218,16 @@ all warnings etc) from the cache.
 compiler output that you would get without the cache. If you ever
 discover a case where ccache changes the output of your compiler then
 please let me know.
+<p><h2>USING CCACHE WITH DISTCC</h2>
+    
+<p>distcc is a very useful program for distributing compilation across a
+range of compiler servers. It is often useful to combine distcc with
+ccache, so that compiles that are done are sped up by distcc, but that
+ccache avoids the compile completely where possible.
+<p>To use distcc with ccache I recommend using the CCACHE_PREFIX
+option. You just need to set the environment variable CCACHE_PREFIX to
+'distcc' and ccache will prefix the command line used with the
+compiler with the command 'distcc'. 
 <p><h2>SHARING A CACHE</h2>
     
 <p>A group of developers can increase the cache hit rate by sharing a