From: Michal Nowikowski <godfryd@isc.org>
Date: Fri, 15 Mar 2019 14:38:03 +0000 (+0100)
Subject: added description of ccache feature in hammer in user guide
X-Git-Tag: Kea-1.6.0-beta~359
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3628c207405afd2cbdb215021da4e7c94357a0d0;p=thirdparty%2Fkea.git

added description of ccache feature in hammer in user guide
---

diff --git a/doc/guide/hammer.xml b/doc/guide/hammer.xml
index 610471e4a2..9d9f1fbccd 100644
--- a/doc/guide/hammer.xml
+++ b/doc/guide/hammer.xml
@@ -112,6 +112,19 @@ freebsd:
     <screen><userinput>./hammer.py ssh -p virtualbox -s freebsd -r 12.0</userinput></screen>
   </para>
 
+  <para>
+    It is possible to speed up subsequent Hammer builds. To achieve this Hammer
+    employs <ulink url="https://ccache.samba.org/">CCache</ulink>. During compilation
+    CCache stores object to shared folder. In subsequent runs instead doing actuall
+    compilation CCache just returns stored earlier objects. Cache with objects for
+    reuse needs to be stored outside of VM or LXC. To indicate such folder Hammer
+    requires providing --ccache-dir parameter. In indicated folder there are stored
+    objects for each target operating system separatelly.
+    <screen><userinput>
+      ./hammer.py build -p lxc -s ubuntu -r 18.04 --ccache-dir ~/kea-ccache
+    </userinput></screen>
+  </para>
+
   <para>
     For more information check: <screen><userinput>./hammer.py --help</userinput></screen>
   </para>