summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKristi Rifenbark <kristi.rifenbark@gmail.com>2017-08-22 16:24:58 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-09-02 00:52:49 +0100
commit47883ade9db35e6d06952975b7a64d34a9aef62c (patch)
treec5b25e3919a0d484b5b05a0bde44034faf744481
parent95d5e56c2985635f8b3f7d1756842265bd4edf25 (diff)
downloadpoky-47883ade9db35e6d06952975b7a64d34a9aef62c.tar.gz
ref-manual: Added new variable COMPONENTS_DIR to glossary
Added new description and created a link for an existing occurance of the variable. (From yocto-docs rev: 9ab6e6aed685c9419cb7df3df3ab029033d9ba0e) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/ref-manual/ref-structure.xml3
-rw-r--r--documentation/ref-manual/ref-variables.xml21
2 files changed, 23 insertions, 1 deletions
diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml
index 1ce323e7a0..3948c64377 100644
--- a/documentation/ref-manual/ref-structure.xml
+++ b/documentation/ref-manual/ref-structure.xml
@@ -810,7 +810,8 @@
810 recipe listed in 810 recipe listed in
811 <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>. 811 <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>.
812 Population of this directory is handled through shared state, while 812 Population of this directory is handled through shared state, while
813 the path is specified by the <filename>COMPONENTS_DIR</filename> 813 the path is specified by the
814 <link linkend='var-COMPONENTS_DIR'><filename>COMPONENTS_DIR</filename></link>
814 variable. Apart from a few unusual circumstances, handling of the 815 variable. Apart from a few unusual circumstances, handling of the
815 <filename>sysroots-components</filename> directory should be 816 <filename>sysroots-components</filename> directory should be
816 automatic, and recipes should not directly reference 817 automatic, and recipes should not directly reference
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 0289ad183f..2b5f0e1494 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -2208,6 +2208,27 @@
2208 </glossdef> 2208 </glossdef>
2209 </glossentry> 2209 </glossentry>
2210 2210
2211 <glossentry id='var-COMPONENTS_DIR'><glossterm>COMPONENTS_DIR</glossterm>
2212 <info>
2213 COMPONENTS_DIR[doc] = "Stores sysroot components for each recipe."
2214 </info>
2215 <glossdef>
2216 <para role="glossdeffirst">
2217<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
2218 Stores sysroot components for each recipe.
2219 The OpenEmbedded build system uses
2220 <filename>COMPONENTS_DIR</filename> when constructing
2221 recipe-specific sysroots for other recipes.
2222 </para>
2223
2224 <para>
2225 The default is
2226 "<filename>${</filename><link linkend='var-STAGING_DIR'><filename>STAGING_DIR</filename></link><filename>}-components</filename>."
2227 (i.e. "<filename>${TMPDIR}/sysroots-components</filename>".
2228 </para>
2229 </glossdef>
2230 </glossentry>
2231
2211 <glossentry id='var-CONF_VERSION'><glossterm>CONF_VERSION</glossterm> 2232 <glossentry id='var-CONF_VERSION'><glossterm>CONF_VERSION</glossterm>
2212 <info> 2233 <info>
2213 CONF_VERSION[doc] = "Tracks the version of local.conf. Increased each time build/conf/ changes incompatibly." 2234 CONF_VERSION[doc] = "Tracks the version of local.conf. Increased each time build/conf/ changes incompatibly."