aboutsummaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-02-15 10:09:15 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-03-03 17:40:10 +0000
commit41e9f7cdac0998b4606007210480ec89874e596f (patch)
treeea086e369974e91c2a5517f2d86300b1bb6f1e90 /documentation/ref-manual
parent5066fbcfb4ef146ed800b1ef0dd6eaf938fd0d90 (diff)
downloadopenembedded-core-contrib-41e9f7cdac0998b4606007210480ec89874e596f.tar.gz
dev-manual, ref-manual: Updated licensing text information.
Fixes [YOCTO #8634] To clear up the behavior the COPY_LIC_DIRS, COPY_LIC_MANIFEST, and LICENSE_CREATE_PACKAGE variable behaviors, I updated the glossary descriptions of the variables. Also, added more info to the "Providing License Text" section in the dev-manual. Tied everything together with good referencing. (From yocto-docs rev: e7b2a1ed29dcd9d572b71f756e7705e6499a05ac) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-variables.xml40
1 files changed, 38 insertions, 2 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index f752856b9d..53bc544b5b 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -2348,7 +2348,20 @@
<filename>/usr/share/common-licenses</filename>,
for each package.
The license files are placed
- in directories within the image itself.
+ in directories within the image itself during build time.
+ <note>
+ The <filename>COPY_LIC_DIRS</filename> does not
+ offer a path for adding licenses for newly installed
+ packages to an image, which might be most suitable
+ for read-only filesystems that cannot be upgraded.
+ See the
+ <link linkend='var-LICENSE_CREATE_PACKAGE'><filename>LICENSE_CREATE_PACKAGE</filename></link>
+ variable for additional information.
+ You can also reference the
+ "<ulink url='&YOCTO_DOCS_DEV_URL;#providing-license-text'>Providing License Text</ulink>"
+ section in the Yocto Project Development Manual for
+ information on providing license text.
+ </note>
</para>
</glossdef>
</glossentry>
@@ -2363,7 +2376,20 @@
If set to "1", the OpenEmbedded build system copies
the license manifest for the image to
<filename>/usr/share/common-licenses/license.manifest</filename>
- within the image itself.
+ within the image itself during build time.
+ <note>
+ The <filename>COPY_LIC_MANIFEST</filename> does not
+ offer a path for adding licenses for newly installed
+ packages to an image, which might be most suitable
+ for read-only filesystems that cannot be upgraded.
+ See the
+ <link linkend='var-LICENSE_CREATE_PACKAGE'><filename>LICENSE_CREATE_PACKAGE</filename></link>
+ variable for additional information.
+ You can also reference the
+ "<ulink url='&YOCTO_DOCS_DEV_URL;#providing-license-text'>Providing License Text</ulink>"
+ section in the Yocto Project Development Manual for
+ information on providing license text.
+ </note>
</para>
</glossdef>
</glossentry>
@@ -7159,6 +7185,16 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<link linkend='var-LIC_FILES_CHKSUM'><filename>LIC_FILES_CHKSUM</filename></link>
as containing license text).
</para>
+
+ <para>
+ For related information on providing license text, see the
+ <link linkend='var-COPY_LIC_DIRS'><filename>COPY_LIC_DIRS</filename></link>
+ variable, the
+ <link linkend='var-COPY_LIC_MANIFEST'><filename>COPY_LIC_MANIFEST</filename></link>
+ variable, and the
+ "<ulink url='&YOCTO_DOCS_DEV_URL;#providing-license-text'>Providing License Text</ulink>"
+ section in the Yocto Project Development Manual.
+ </para>
</glossdef>
</glossentry>