summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-12-16 15:39:33 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-01-02 13:16:09 +0000
commit61597c48ee928ac79b832cccea61f94953aa7383 (patch)
tree98869237d432081f569e32dfda9ab7b2605bc333 /documentation
parentd2c89c7cfd36eefe61debac60aeafe7aa34ab526 (diff)
downloadpoky-61597c48ee928ac79b832cccea61f94953aa7383.tar.gz
ref-manual: Edits to the icecc class.
Added some more information around the use of the ICECC_DISABLED variable. Information from Martin. Reported-by: Martin Jansa <martin.jansa@gmail.com> (From yocto-docs rev: 25990dbe66690991babda602ef40df948b70b038) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/ref-classes.xml32
1 files changed, 32 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index ca96b3b277..ea280cb305 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -1000,6 +1000,38 @@
1000 <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link> 1000 <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link>
1001 variable. 1001 variable.
1002 </para> 1002 </para>
1003
1004 <para>
1005 Inheriting the <filename>icecc</filename> class changes all sstate
1006 signatures.
1007 Consequently, if a development team has a dedicated build system
1008 that populates
1009 <link linkend='var-SSTATE_MIRRORS'><filename>STATE_MIRRORS</filename></link>
1010 and they want to reuse sstate from
1011 <filename>STATE_MIRRORS</filename>, then all developers and the
1012 build system need to either inherit the <filename>icecc</filename>
1013 class or nobody should.
1014 </para>
1015
1016 <para>
1017 At the distribution level, you can inherit the
1018 <filename>icecc</filename> class to be sure that all builders start
1019 with the same sstate signatures.
1020 After inheriting the class, you can then disable the feature by setting
1021 the
1022 <link linkend='var-ICECC_DISABLED'><filename>ICECC_DISABLED</filename></link>
1023 variable to "1" as follows:
1024 <literallayout class='monospaced'>
1025 INHERIT_DISTRO += "icecc"
1026 ICECC_DISABLED ??= "1"
1027 </literallayout>
1028 This practice makes sure everyone is using the same signatures but also
1029 requires individuals that do want to use Icecream to enable the feature
1030 individually as follows in your <filename>local.conf</filename> file:
1031 <literallayout class='monospaced'>
1032 ICECC_DISABLED = ""
1033 </literallayout>
1034 </para>
1003</section> 1035</section>
1004 1036
1005<section id='ref-classes-image'> 1037<section id='ref-classes-image'>