sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

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>
This commit is contained in:
Scott Rifenbark 2016-02-15 10:09:15 -08:00 committed by Richard Purdie
parent 5066fbcfb4
commit 41e9f7cdac
2 changed files with 57 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
documentation/dev-manual/dev-manual-common-tasks.xml
View File

@ -9977,6 +9977,25 @@
Adding these statements to the configuration file ensures Adding these statements to the configuration file ensures
that the licenses collected during package generation that the licenses collected during package generation
are included on your image. are included on your image.
<note>
<para>Setting all three variables to "1" results in the
image having two copies of the same license file.
One copy resides in
<filename>/usr/share/common-licenses</filename> and
the other resides in
<filename>/usr/share/license</filename>.</para>
<para>The reason for this behavior is because
<ulink url='&YOCTO_DOCS_REF_URL;#var-COPY_LIC_DIRS'><filename>COPY_LIC_DIRS</filename></ulink>
and
<ulink url='&YOCTO_DOCS_REF_URL;#var-COPY_LIC_MANIFEST'><filename>COPY_LIC_MANIFEST</filename></ulink>
add a copy of the license when the image is built but do not
offer a path for adding licenses for newly installed packages
to an image.
<ulink url='&YOCTO_DOCS_REF_URL;#var-LICENSE_CREATE_PACKAGE'><filename>LICENSE_CREATE_PACKAGE</filename></ulink>
adds a separate package and an upgrade path for adding
licenses to an image.</para>
</note>
</para> </para>
<para> <para>
@ -9986,15 +10005,6 @@
of the license information with source as defined by the GPL of the license information with source as defined by the GPL
and other open source licenses. and other open source licenses.
</para> </para>
<para>
See the
<ulink url='&YOCTO_DOCS_REF_URL;#var-LICENSE_CREATE_PACKAGE'><filename>LICENSE_CREATE_PACKAGE</filename></ulink>,
<ulink url='&YOCTO_DOCS_REF_URL;#var-COPY_LIC_DIRS'><filename>COPY_LIC_DIRS</filename></ulink>,
and
<ulink url='&YOCTO_DOCS_REF_URL;#var-COPY_LIC_MANIFEST'><filename>COPY_LIC_MANIFEST</filename></ulink>
variable descriptions for more information.
</para>
</section> </section>
<section id='providing-compilation-scripts-and-source-code-modifications'> <section id='providing-compilation-scripts-and-source-code-modifications'>

40
documentation/ref-manual/ref-variables.xml
View File

@ -2348,7 +2348,20 @@
<filename>/usr/share/common-licenses</filename>, <filename>/usr/share/common-licenses</filename>,
for each package. for each package.
The license files are placed 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> </para>
</glossdef> </glossdef>
</glossentry> </glossentry>
@ -2363,7 +2376,20 @@
If set to "1", the OpenEmbedded build system copies If set to "1", the OpenEmbedded build system copies
the license manifest for the image to the license manifest for the image to
<filename>/usr/share/common-licenses/license.manifest</filename> <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> </para>
</glossdef> </glossdef>
</glossentry> </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> <link linkend='var-LIC_FILES_CHKSUM'><filename>LIC_FILES_CHKSUM</filename></link>
as containing license text). as containing license text).
</para> </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> </glossdef>
</glossentry> </glossentry>