aboutsummaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2015-04-30 08:25:02 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2015-07-28 18:02:27 +0100
commitd0531dbf0e5f4f8612b5164674f9140b1d86010b (patch)
tree5165901db5b67146e398d6497883bfe5e236a6f2 /documentation
parent46f86497d5cc0515266dd49db42861f1c9882b6d (diff)
downloadopenembedded-core-contrib-d0531dbf0e5f4f8612b5164674f9140b1d86010b.tar.gz
ref-manual: Added new variable description for ARCHIVER_MODE
Also, added a cross-reference link from the archiver.bbclass section to the new description. (From yocto-docs rev: f825ba932970e9d62d335f249365a34b2992b6cd) 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.xml3
-rw-r--r--documentation/ref-manual/ref-variables.xml21
2 files changed, 24 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index eb3e2718a7..72295d737c 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -93,6 +93,9 @@
For more details on the source archiver, see the
"<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Product's Lifecycle</ulink>"
section in the Yocto Project Development Manual.
+ You can also see the
+ <link linkend='var-ARCHIVER_MODE'><filename>ARCHIVER_MODE</filename></link>
+ variable.
</para>
</section>
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index ecac2b6c26..71bd8e5260 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -283,6 +283,27 @@
</glossdef>
</glossentry>
+ <glossentry id='var-ARCHIVER_MODE'><glossterm>ARCHIVER_MODE</glossterm>
+ <info>
+ ARCHIVER_MODE[doc] = "Controls archive creation used when releasing source files."
+ </info>
+ <glossdef>
+ <para role="glossdeffirst">
+<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
+ When used with the
+ <link linkend='ref-classes-archiver'><filename>archiver</filename></link>
+ class, determines the type of information used to create
+ a released archive.
+ You can use this variable to create archives of patched
+ source, original source, configured source, and so forth.
+ For information on how the variable works, see the
+ <filename>meta/classes/archiver.bbclass</filename> file
+ in the
+ <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
+ </para>
+ </glossdef>
+ </glossentry>
+
<glossentry id='var-AS'><glossterm>AS</glossterm>
<info>
AS[doc] = "Minimal command and arguments to run the assembler."