ref-manual, bsp-guide: Added cross-references for two variables.

Added several cross-link references for the LICENSE_FLAGS and
LICENSE_FLAGS_WHITELIST variables.  Note that the cross-references
previously put in for LICENSE_FLAGS were slightly wrong as they
were using the <ulink> tag instead of the <link> tag.

(From yocto-docs rev: dc2769c63d24d3650c993cfd48bcb4540ad36ca2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2014-07-01 09:52:29 +03:00 committed by Richard Purdie
parent 980ad4ed0c
commit 8d0d487a12
2 changed files with 8 additions and 7 deletions

View File

@ -1009,7 +1009,7 @@
For each of those recipes, you can For each of those recipes, you can
specify a matching license string in a specify a matching license string in a
<filename>local.conf</filename> variable named <filename>local.conf</filename> variable named
<filename>LICENSE_FLAGS_WHITELIST</filename>. <ulink url='&YOCTO_DOCS_REF_URL;#var-LICENSE_FLAGS_WHITELIST'><filename>LICENSE_FLAGS_WHITELIST</filename></ulink>.
Specifying the matching license string signifies that you agree to the license. Specifying the matching license string signifies that you agree to the license.
Thus, the build system can build the corresponding recipe and include Thus, the build system can build the corresponding recipe and include
the component in the image. the component in the image.

View File

@ -1208,7 +1208,7 @@
requirements. requirements.
Such requirements are defined on a Such requirements are defined on a
recipe-by-recipe basis through the recipe-by-recipe basis through the
<ulink url='&YOCTO_DOCS_REF_URL;#var-LICENSE_FLAGS'><filename>LICENSE_FLAGS</filename></ulink> <link linkend='var-LICENSE_FLAGS'><filename>LICENSE_FLAGS</filename></link>
variable definition in the affected recipe. variable definition in the affected recipe.
For instance, the For instance, the
<filename>poky/meta/recipes-multimedia/gstreamer/gst-plugins-ugly</filename> <filename>poky/meta/recipes-multimedia/gstreamer/gst-plugins-ugly</filename>
@ -1224,7 +1224,8 @@
In order for a component restricted by a <filename>LICENSE_FLAGS</filename> In order for a component restricted by a <filename>LICENSE_FLAGS</filename>
definition to be enabled and included in an image, it definition to be enabled and included in an image, it
needs to have a matching entry in the global needs to have a matching entry in the global
<filename>LICENSE_FLAGS_WHITELIST</filename> variable, which is a variable <link linkend='var-LICENSE_FLAGS_WHITELIST'><filename>LICENSE_FLAGS_WHITELIST</filename></link>
variable, which is a variable
typically defined in your <filename>local.conf</filename> file. typically defined in your <filename>local.conf</filename> file.
For example, to enable For example, to enable
the <filename>poky/meta/recipes-multimedia/gstreamer/gst-plugins-ugly</filename> the <filename>poky/meta/recipes-multimedia/gstreamer/gst-plugins-ugly</filename>
@ -1270,10 +1271,10 @@
License flag matching allows you to control what recipes the License flag matching allows you to control what recipes the
OpenEmbedded build system includes in the build. OpenEmbedded build system includes in the build.
Fundamentally, the build system attempts to match Fundamentally, the build system attempts to match
<ulink url='&YOCTO_DOCS_REF_URL;#var-LICENSE_FLAGS'><filename>LICENSE_FLAGS</filename></ulink> <link linkend='var-LICENSE_FLAGS'><filename>LICENSE_FLAGS</filename></link>
strings found in recipes against strings found in recipes against
<filename>LICENSE_FLAGS_WHITELIST</filename> strings found in <link linkend='var-LICENSE_FLAGS_WHITELIST'><filename>LICENSE_FLAGS_WHITELIST</filename></link>
the whitelist. strings found in the whitelist.
A match causes the build system to include a recipe in the A match causes the build system to include a recipe in the
build, while failure to find a match causes the build system to build, while failure to find a match causes the build system to
exclude a recipe. exclude a recipe.
@ -1396,7 +1397,7 @@
for those components using the more general "commercial" for those components using the more general "commercial"
in the whitelist, but that would also enable all the in the whitelist, but that would also enable all the
other packages with other packages with
<ulink url='&YOCTO_DOCS_REF_URL;#var-LICENSE_FLAGS'><filename>LICENSE_FLAGS</filename></ulink> <link linkend='var-LICENSE_FLAGS'><filename>LICENSE_FLAGS</filename></link>
containing "commercial", which you may or may not want: containing "commercial", which you may or may not want:
<literallayout class='monospaced'> <literallayout class='monospaced'>
LICENSE_FLAGS_WHITELIST = "commercial" LICENSE_FLAGS_WHITELIST = "commercial"