summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.xml
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-02-02 17:29:37 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-02-04 23:22:49 +0000
commit0d8bd7d6ba79410d9349846a798cf6e7c279fa5d (patch)
treec992a6127f46fb2eb93b0b9da60cf3fe895bac72 /documentation/ref-manual/ref-variables.xml
parent6aca5b82c9163b1f9fe322fbb599cb0739936e3b (diff)
downloadpoky-0d8bd7d6ba79410d9349846a798cf6e7c279fa5d.tar.gz
ref-manual: Added description for LICENSE_CREATE_PACKAGE variable.
Fixes [YOCTO #8633] Added a new variable description for LICENSE_CREATE_PACKAGE. (From yocto-docs rev: 49a2f8384e67a90d5b3227ab0de3d12eb311bd20) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/ref-variables.xml')
-rw-r--r--documentation/ref-manual/ref-variables.xml33
1 files changed, 33 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 49aea7a147..8c7d7d436d 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -7129,6 +7129,39 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7129 </glossdef> 7129 </glossdef>
7130 </glossentry> 7130 </glossentry>
7131 7131
7132 <glossentry id='var-LICENSE_CREATE_PACKAGE'><glossterm>LICENSE_CREATE_PACKAGE</glossterm>
7133 <info>
7134 LICENSE_CREATE_PACKAGE[doc] = "Creates an extra package (i.e. ${PN}-lic) for each recipe and adds that package to the RRECOMMENDS+${PN}."
7135 </info>
7136 <glossdef>
7137 <para role="glossdeffirst">
7138<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
7139 Setting <filename>LICENSE_CREATE_PACKAGE</filename>
7140 to "1" causes the OpenEmbedded build system to create
7141 an extra package (i.e.
7142 <filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}-lic</filename>)
7143 for each recipe and to add those packages to the
7144 <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link><filename>_${PN}</filename>.
7145 </para>
7146
7147 <para>
7148 The <filename>${PN}-lic</filename> package installs a
7149 directory in <filename>/usr/share-licenses</filename>
7150 named <filename>${PN}</filename>, which is the recipe's
7151 base name, and installs files in that directory that
7152 contain license and copyright information (i.e. copies of
7153 the appropriate license files from
7154 <filename>meta/common-licenses</filename> that match the
7155 licenses specified in the
7156 <link linkend='var-LICENSE'><filename>LICENSE</filename></link>
7157 variable of the recipe metadata and copies of files marked
7158 in
7159 <link linkend='var-LIC_FILES_CHKSUM'><filename>LIC_FILES_CHKSUM</filename></link>
7160 as containing license text).
7161 </para>
7162 </glossdef>
7163 </glossentry>
7164
7132 <glossentry id='var-LICENSE_FLAGS'><glossterm>LICENSE_FLAGS</glossterm> 7165 <glossentry id='var-LICENSE_FLAGS'><glossterm>LICENSE_FLAGS</glossterm>
7133 <info> 7166 <info>
7134 LICENSE_FLAGS[doc] = "Specifies additional flags for a recipe you must whitelist through LICENSE_FLAGS_WHITELIST in order to allow the recipe to be built." 7167 LICENSE_FLAGS[doc] = "Specifies additional flags for a recipe you must whitelist through LICENSE_FLAGS_WHITELIST in order to allow the recipe to be built."