[Bug 222765] update ccache documentation to refer to src.conf

[bugzilla-noreply at freebsd.org]

https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=222765

            Bug ID: 222765
           Summary: update ccache documentation to refer to src.conf
           Product: Ports & Packages
           Version: Latest
          Hardware: Any
                OS: Any
            Status: New
          Severity: Affects Many People
          Priority: ---
         Component: Individual Port(s)
          Assignee: freebsd-ports-bugs at FreeBSD.org
          Reporter: pete at nomadlogic.org

the documentation installed at
/usr/local/share/doc/ccache/ccache-howto-freebsd.txt seems to provide incorrect
directions for using ccache to build your world and kernel.  specifically it
seems you only need to update /etc/src.conf to enable ccache as opposed to the
older approach of using make.conf.  furthermore using the instructions bellow
no longer seem to work.  

this diff updates the documentation to refer to the current need to only update
/etc/src.conf to successfully utilize ccache for buildworld and buildkernel:

$ diff -u devel/ccache/files/ccache-howto-freebsd.txt.in.bak
devel/ccache/files/ccache-howto-freebsd.txt.in

--- devel/ccache/files/ccache-howto-freebsd.txt.in.bak  2017-10-03
17:05:38.657820000 -0700
+++ devel/ccache/files/ccache-howto-freebsd.txt.in      2017-10-03
17:07:07.420574000 -0700
@@ -6,27 +6,11 @@
 /etc/make.conf. The rest of this guide is for building
 /usr/src and other checkouts.

-To use ccache for base add the following to /etc/make.conf.
-You can replace cc and c++ with the compilers of your choice.
-(remember that only GCC and Clang can build world and kernel)
+To use ccache for base add the following to /etc/src.conf.
+WITH_CCACHE_BUILD=true

-.if (!empty(.CURDIR:M/usr/src*) || !empty(.CURDIR:M/usr/obj*))
-.if !defined(NOCCACHE) && exists(%%PREFIX%%/%%CCLINKDIR%%/world/cc)
-CC:=${CC:C,^cc,%%PREFIX%%/%%CCLINKDIR%%/world/cc,1}
-CXX:=${CXX:C,^c\+\+,%%PREFIX%%/%%CCLINKDIR%%/world/c++,1}
-.endif
-.endif
-
-For Korn/Bourne shells Add the following to /etc/profile:
- export PATH=%%PREFIX%%/%%CCLINKDIR%%:$PATH
- export CCACHE_PATH=/usr/bin:%%LOCALBASE%%/bin
-
-For csh/tcsh Add the following to /etc/csh.cshrc:
- setenv PATH %%PREFIX%%/%%CCLINKDIR%%:$PATH
- setenv CCACHE_PATH /usr/bin:%%LOCALBASE%%/bin
-
-For icc users:
- Add %%ICCPREFIX%% to CCACHE_PATH
+Refer to src.conf(5) for more detailed instructions on using
+ccache to build the base system.

 --

-- 
You are receiving this mail because:
You are the assignee for the bug.