summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-08-13 14:43:52 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-08-13 13:19:00 +0100
commit35655863cad0ebcb78001bafd781e212bdffe4bc (patch)
tree8cc30c8f7cc75932bf0a426640ddce8f60a26d84
parentb7c167af1ca0b12d0b53c073c0bbb179b8ecdc3d (diff)
downloadpoky-35655863cad0ebcb78001bafd781e212bdffe4bc.tar.gz
ref-manual: Review comments added, new variables added
* Updated some links in the insane.bbclass sectioni so they now point to some new variables. * Added glossary descriptions for PKGD, PKGDEST, and INCOMPATIBLE_LICENSE. * Added a paragraph to the LICENSE variable to describe situations where the output might have components whose licensing is from two different licenses (licensing on a per-package basis). (From yocto-docs rev: b8dd3b3d5cb912ed7c5d3c9b6c01d93347e95b84) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/ref-manual/ref-classes.xml6
-rw-r--r--documentation/ref-manual/ref-variables.xml75
2 files changed, 77 insertions, 4 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index 42f33e811e..7a5a5ddb58 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -648,7 +648,7 @@
648 <listitem><para><emphasis><filename>incompatible-license:</filename></emphasis> 648 <listitem><para><emphasis><filename>incompatible-license:</filename></emphasis>
649 Report when packages are excluded from being created due to 649 Report when packages are excluded from being created due to
650 being marked with a license that is in 650 being marked with a license that is in
651 <filename>INCOMPATIBLE_LICENSE</filename>. 651 <link linkend='var-INCOMPATIBLE_LICENSE'><filename>INCOMPATIBLE_LICENSE</filename></link>.
652 </para></listitem> 652 </para></listitem>
653 <listitem><para><emphasis><filename>compile-host-path:</filename></emphasis> 653 <listitem><para><emphasis><filename>compile-host-path:</filename></emphasis>
654 Checks the <filename>do_compile</filename> log for indications 654 Checks the <filename>do_compile</filename> log for indications
@@ -762,8 +762,8 @@
762 <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>, 762 <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>,
763 <link linkend='var-D'><filename>D</filename></link>, 763 <link linkend='var-D'><filename>D</filename></link>,
764 <link linkend='var-PN'><filename>PN</filename></link>, and 764 <link linkend='var-PN'><filename>PN</filename></link>, and
765 <filename>PKGD</filename>) are undefined during 765 <link linkend='var-PKGD'><filename>PKGD</filename></link>) are
766 <filename>do_package</filename>. 766 undefined during <filename>do_package</filename>.
767 </para></listitem> 767 </para></listitem>
768 <listitem><para><emphasis><filename>pkgv-undefined:</filename></emphasis> 768 <listitem><para><emphasis><filename>pkgv-undefined:</filename></emphasis>
769 Checks to see if the <filename>PKGV</filename> variable 769 Checks to see if the <filename>PKGV</filename> variable
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 7b88ffe5ca..099846412b 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -1727,7 +1727,7 @@ Core layer for images cannot be removed
1727 <glossentry id='var-IMAGE_FSTYPES'><glossterm>IMAGE_FSTYPES</glossterm> 1727 <glossentry id='var-IMAGE_FSTYPES'><glossterm>IMAGE_FSTYPES</glossterm>
1728 <glossdef> 1728 <glossdef>
1729 <para> 1729 <para>
1730 Specifes the format of the root filesystem created by 1730 Specifies the format of the root filesystem created by
1731 the OpenEmbedded build system. 1731 the OpenEmbedded build system.
1732 Available formats are a subset of the 1732 Available formats are a subset of the
1733 supported images listed in 1733 supported images listed in
@@ -2009,6 +2009,33 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
2009 </glossdef> 2009 </glossdef>
2010 </glossentry> 2010 </glossentry>
2011 2011
2012 <glossentry id='var-INCOMPATIBLE_LICENSE'><glossterm>INCOMPATIBLE_LICENSE</glossterm>
2013 <glossdef>
2014 <para>
2015 Specifies a space-separated list of license names
2016 (as they would appear in
2017 <link linkend='var-LICENSE'><filename>LICENSE</filename></link>)
2018 that should be excluded from the build.
2019 Recipes that provide no alternatives to listed incompatible
2020 licenses are not built.
2021 Packages that are individually licensed with the specified
2022 incompatible licenses will be deleted.
2023 </para>
2024
2025 <note>
2026 This functionality is only regularly tested using
2027 the following setting:
2028 <literallayout class='monospaced'>
2029 INCOMPATIBLE_LICENSE = "GPLv3"
2030 </literallayout>
2031 Although you can use other settings, you might be required
2032 to remove dependencies on or provide alternatives to
2033 components that are required to produce a functional system
2034 image.
2035 </note>
2036 </glossdef>
2037 </glossentry>
2038
2012 <glossentry id='var-INHIBIT_DEFAULT_DEPS'><glossterm>INHIBIT_DEFAULT_DEPS</glossterm> 2039 <glossentry id='var-INHIBIT_DEFAULT_DEPS'><glossterm>INHIBIT_DEFAULT_DEPS</glossterm>
2013 <glossdef> 2040 <glossdef>
2014 <para> 2041 <para>
@@ -2583,6 +2610,21 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
2583 The final example is from <filename>sysstat</filename>, 2610 The final example is from <filename>sysstat</filename>,
2584 which presents a single license. 2611 which presents a single license.
2585 </para> 2612 </para>
2613
2614 <para>
2615 You can also specify licenses on a per-package basis to
2616 handle situations where components of the output have
2617 different licenses.
2618 For example, a piece of software whose code is
2619 licensed under GPLv2 but has accompanying documentation
2620 licensed under the GNU Free Documentation License 1.2 could
2621 be specified as follows:
2622 <literallayout class='monospaced'>
2623 LICENSE = "GFDL-1.2 &amp; GPLv2"
2624 LICENSE_${PN} = "GPLv2"
2625 LICENSE_${PN}-doc = "GFDL-1.2"
2626 </literallayout>
2627 </para>
2586 </glossdef> 2628 </glossdef>
2587 </glossentry> 2629 </glossentry>
2588 2630
@@ -3417,6 +3459,37 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3417 </glossdef> 3459 </glossdef>
3418 </glossentry> 3460 </glossentry>
3419 3461
3462 <glossentry id='var-PKGD'><glossterm>PKGD</glossterm>
3463 <glossdef>
3464 <para>
3465 Points to the destination directory for files to be
3466 packaged before they are split into individual packages.
3467 This directory defaults to the following:
3468 <literallayout class='monospaced'>
3469 ${WORKDIR}/package
3470 </literallayout>
3471 Do not change this default.
3472 </para>
3473 </glossdef>
3474 </glossentry>
3475
3476 <glossentry id='var-PKGDEST'><glossterm>PKGDEST</glossterm>
3477 <glossdef>
3478 <para>
3479 Points to the parent directory for files to be packaged
3480 after they have been split into individual packages.
3481 This directory defaults to the following:
3482 <literallayout class='monospaced'>
3483 ${WORKDIR}/packages-split
3484 </literallayout>
3485 Under this default directory, the build system creates
3486 directories for each package specified in
3487 <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link>.
3488 Do not change this default.
3489 </para>
3490 </glossdef>
3491 </glossentry>
3492
3420 <glossentry id='var-PN'><glossterm>PN</glossterm> 3493 <glossentry id='var-PN'><glossterm>PN</glossterm>
3421 <glossdef> 3494 <glossdef>
3422 <para>This variable can have two separate functions depending on the context: a recipe 3495 <para>This variable can have two separate functions depending on the context: a recipe