Update CCACHE docs, patch by Ryan Hill (bug #156865)

svn path=/main/trunk/; revision=5543

diff --git a/cnf/make.conf b/cnf/make.conf
index 5be65cc3bb95218a1cd9d17d490e00bff1f81aa1..7bff547eaad54ca16f73bde4187fdff215a02345 100644 (file)
--- a/cnf/make.conf
+++ b/cnf/make.conf
@@ -246,7 +246,9 @@
 #                generates digests only when the 'digest' feature is enabled).
 #  'buildpkg'    causes binary packages to be created of all packages that 
 #                are being merged.
-#  'ccache'      enables ccache support via CC.
+#  'ccache'      enable support for the dev-util/ccache package, which can
+#                noticably decrease the time needed to remerge previously built
+#                packages.
 #  'confcache'   enable confcache support; speeds up autotool based configure
 #                calls
 #  'collision-protect'
@@ -298,16 +300,25 @@
 #  'usersandbox' enables sandboxing while portage is running under userpriv.
 #FEATURES="sandbox buildpkg ccache distcc userpriv usersandbox notitles noclean noauto cvs keeptemp keepwork"
 #FEATURES="sandbox ccache distcc distlocks"
+
+# CCACHE_SIZE and CCACHE_DIR are used to control the behavior of ccache, and
+#     and are only used if "ccache" is in FEATURES.
+#
+# CCACHE_SIZE sets the space limitations for ccache. The default size is
+#     "2G", or 2 gigabytes.  Units are specified with 'G', 'M', or 'K'.
 #
-# CCACHE_SIZE sets the space use limitations for ccache. The default size is
-#     2G, and will be set if not defined otherwise and ccache is in features. 
-#     Portage will set the default ccache dir if it is not present in the
-#     user's environment, for userpriv it sets: ${PORTAGE_TMPDIR}/ccache
-#     (/var/tmp/ccache), and for regular use the default is /root/.ccache.
-#     Sizes are specified with 'G' 'M' or 'K'.
-#     '2G' for 2 gigabytes, '2048M' for 2048 megabytes (same as 2G).
 #CCACHE_SIZE="512M"
 #
+# CCACHE_DIR sets the ccache path.  If not specified, portage will default
+#     to "${PORTAGE_TMPDIR}/ccache".
+#
+#     Note that to display ccache statistics outside of portage, you must
+#     remember to give the correct path to the cache.
+#
+#        $ CCACHE_DIR=/var/tmp/ccache ccache -s 
+#
+#CCACHE_DIR="${PORTAGE_TMPDIR}/ccache"
+
 # DISTCC_DIR sets the temporary space used by distcc.
 #DISTCC_DIR="${PORTAGE_TMPDIR}/.distcc"
 

diff --git a/man/make.conf.5 b/man/make.conf.5
index 2f526436cd180468d5e7f6a28168cc01b8578ac1..304b5ea9e0bb2008cf6a1120dca4f480be3e1d20 100644 (file)
--- a/man/make.conf.5
+++ b/man/make.conf.5
@@ -133,7 +133,7 @@ Build binary packages for just packages in the system set.
 .B ccache
 Enable portage support for the ccache package.  If the ccache dir is not 
 present in the user's environment, then portage will default to 
-${PORTAGE_TMPDIR}/ccache (with \fIuserpriv\fR) and to /root/.ccache otherwise.
+${PORTAGE_TMPDIR}/ccache.
 .TP
 .B confcache
 Enable confcache support; global configure caching, speeds up autotool based configure