ref-manual: Added five "COPYLEFT*" variables to the glossary.
Fixes [YOCTO #11021] The "Maintaining Open Source License Compliance During Your Product's Lifecycle" section in the dev manual covers use of archiver.bbclass, but is missing mention of the filtering options (e.g COPYLEFT_LICENSE_INCLUDE, COPYLEFT_LICENSE_EXCLUDE and COPYLEFT_RECIPE_TYPES). I added descriptions for these three. During the write-up, Paul noticed a couple other variables missing: COPYLEFT_PN_INCLUDE and COPYLEFT_PN_EXCLUDE. I also added descriptions for these two variables. (From yocto-docs rev: 450311037ea3048d30057c0b9d294efd33db2d3c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
parent
cc970c23a7
commit
e6ed5a6804
|
@ -2364,6 +2364,161 @@
|
|||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id='var-COPYLEFT_LICENSE_EXCLUDE'><glossterm>COPYLEFT_LICENSE_EXCLUDE</glossterm>
|
||||
<info>
|
||||
COPYLEFT_LICENSE_EXCLUDE[doc] = "Licenses to exclude in the source archived by the archiver class."
|
||||
</info>
|
||||
<glossdef>
|
||||
<para role="glossdeffirst">
|
||||
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
|
||||
A space-separated list of licenses to exclude from the
|
||||
source archived by the
|
||||
<link linkend='ref-classes-archiver'><filename>archiver</filename></link>
|
||||
class.
|
||||
In other words, if a license in a recipe's
|
||||
<link linkend='var-LICENSE'><filename>LICENSE</filename></link>
|
||||
value is in the value of
|
||||
<filename>COPYLEFT_LICENSE_EXCLUDE</filename>, then its
|
||||
source is not archived by the class.
|
||||
<note>
|
||||
The <filename>COPYLEFT_LICENSE_EXCLUDE</filename>
|
||||
variable takes precedence over the
|
||||
<link linkend='var-COPYLEFT_LICENSE_INCLUDE'><filename>COPYLEFT_LICENSE_INCLUDE</filename></link>
|
||||
variable.
|
||||
</note>
|
||||
The default value, which is "CLOSED Proprietary", for
|
||||
<filename>COPYLEFT_LICENSE_EXCLUDE</filename> is set
|
||||
by the
|
||||
<link linkend='ref-classes-copyleft_filter'><filename>copyleft_filter</filename></link>
|
||||
class, which is inherited by the
|
||||
<filename>archiver</filename> class.
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id='var-COPYLEFT_LICENSE_INCLUDE'><glossterm>COPYLEFT_LICENSE_INCLUDE</glossterm>
|
||||
<info>
|
||||
COPYLEFT_LICENSE_INCLUDE[doc] = "Licenses to include in the source archived by the archiver class."
|
||||
</info>
|
||||
<glossdef>
|
||||
<para role="glossdeffirst">
|
||||
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
|
||||
A space-separated list of licenses to include in the
|
||||
source archived by the
|
||||
<link linkend='ref-classes-archiver'><filename>archiver</filename></link>
|
||||
class.
|
||||
In other words, if a license in a recipe's
|
||||
<link linkend='var-LICENSE'><filename>LICENSE</filename></link>
|
||||
value is in the value of
|
||||
<filename>COPYLEFT_LICENSE_INCLUDE</filename>, then its
|
||||
source is archived by the class.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The default value, which is "GPL* LGPL*", for
|
||||
<filename>COPYLEFT_LICENSE_INCLUDE</filename> is set
|
||||
by the
|
||||
<link linkend='ref-classes-copyleft_filter'><filename>copyleft_filter</filename></link>
|
||||
class, which is inherited by the
|
||||
<filename>archiver</filename> class.
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id='var-COPYLEFT_PN_EXCLUDE'><glossterm>COPYLEFT_PN_EXCLUDE</glossterm>
|
||||
<info>
|
||||
COPYLEFT_PN_EXCLUDE[doc] = "Recipes to exclude in the source archived by the archiver class."
|
||||
</info>
|
||||
<glossdef>
|
||||
<para role="glossdeffirst">
|
||||
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
|
||||
A list of recipes to exclude in the source archived
|
||||
by the
|
||||
<link linkend='ref-classes-archiver'><filename>archiver</filename></link>
|
||||
class.
|
||||
The <filename>COPYLEFT_PN_EXCLUDE</filename> variable
|
||||
overrides the license inclusion and exclusion caused
|
||||
through the
|
||||
<link linkend='var-COPYLEFT_LICENSE_INCLUDE'><filename>COPYLEFT_LICENSE_INCLUDE</filename></link>
|
||||
and
|
||||
<link linkend='var-COPYLEFT_LICENSE_EXCLUDE'><filename>COPYLEFT_LICENSE_EXCLUDE</filename></link>
|
||||
variables, respectively.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The default value, which is "" indicating to not explicitly
|
||||
exclude any recipes by name, for
|
||||
<filename>COPYLEFT_PN_EXCLUDE</filename> is set
|
||||
by the
|
||||
<link linkend='ref-classes-copyleft_filter'><filename>copyleft_filter</filename></link>
|
||||
class, which is inherited by the
|
||||
<filename>archiver</filename> class.
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id='var-COPYLEFT_PN_INCLUDE'><glossterm>COPYLEFT_PN_INCLUDE</glossterm>
|
||||
<info>
|
||||
COPYLEFT_PN_INCLUDE[doc] = "Recipes to include in the source archived by the archiver class."
|
||||
</info>
|
||||
<glossdef>
|
||||
<para role="glossdeffirst">
|
||||
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
|
||||
A list of recipes to include in the source archived
|
||||
by the
|
||||
<link linkend='ref-classes-archiver'><filename>archiver</filename></link>
|
||||
class.
|
||||
The <filename>COPYLEFT_PN_INCLUDE</filename> variable
|
||||
overrides the license inclusion and exclusion caused
|
||||
through the
|
||||
<link linkend='var-COPYLEFT_LICENSE_INCLUDE'><filename>COPYLEFT_LICENSE_INCLUDE</filename></link>
|
||||
and
|
||||
<link linkend='var-COPYLEFT_LICENSE_EXCLUDE'><filename>COPYLEFT_LICENSE_EXCLUDE</filename></link>
|
||||
variables, respectively.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The default value, which is "" indicating to not explicitly
|
||||
include any recipes by name, for
|
||||
<filename>COPYLEFT_PN_INCLUDE</filename> is set
|
||||
by the
|
||||
<link linkend='ref-classes-copyleft_filter'><filename>copyleft_filter</filename></link>
|
||||
class, which is inherited by the
|
||||
<filename>archiver</filename> class.
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id='var-COPYLEFT_RECIPE_TYPES'><glossterm>COPYLEFT_RECIPE_TYPES</glossterm>
|
||||
<info>
|
||||
COPYLEFT_RECIPE_TYPES[doc] = "Recipe types to include in the source archived by the archiver class."
|
||||
</info>
|
||||
<glossdef>
|
||||
<para role="glossdeffirst">
|
||||
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
|
||||
A space-separated list of recipe types to include
|
||||
in the source archived by the
|
||||
<link linkend='ref-classes-archiver'><filename>archiver</filename></link>
|
||||
class.
|
||||
Recipe types are <filename>target</filename>,
|
||||
<filename>native</filename>,
|
||||
<filename>nativesdk</filename>,
|
||||
<filename>cross</filename>,
|
||||
<filename>crosssdk</filename>, and
|
||||
<filename>cross-canadian</filename>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The default value, which is "target*", for
|
||||
<filename>COPYLEFT_RECIPE_TYPES</filename> is set
|
||||
by the
|
||||
<link linkend='ref-classes-copyleft_filter'><filename>copyleft_filter</filename></link>
|
||||
class, which is inherited by the
|
||||
<filename>archiver</filename> class.
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id='var-COPY_LIC_DIRS'><glossterm>COPY_LIC_DIRS</glossterm>
|
||||
<info>
|
||||
COPY_LIC_DIRS[doc] = "If set to "1" along with the COPY_LIC_MANIFEST variable, the OpenEmbedded build system copies into the image the license files, which are located in /usr/share/common-licenses, for each package."
|
||||
|
|
Loading…
Reference in New Issue