summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-09-20 13:47:34 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-09-24 16:36:07 +0100
commit19bd5f07256276e40edf62b2447c3ca3a3914cab (patch)
tree7e5fc09fd7f6256a724df30b35bbff67f46de94b
parent35abb93edfae4d16143008eb100fca7e2cf21296 (diff)
downloadpoky-19bd5f07256276e40edf62b2447c3ca3a3914cab.tar.gz
poky-19bd5f07256276e40edf62b2447c3ca3a3914cab.tar.bz2
poky-19bd5f07256276e40edf62b2447c3ca3a3914cab.zip
documentation/poky-ref-manual: PN scrub
Checked and fixed all text surrounding the description and use of the PN variable. This variable can mean a recipe or a resulting package depending on context. (From yocto-docs rev: 7ac52f6b184670db9cdab7c205126b62c60b0d29) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/poky-ref-manual/ref-variables.xml16
-rw-r--r--documentation/poky-ref-manual/technical-details.xml4
2 files changed, 13 insertions, 7 deletions
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index 1ef8163c6e..9caa51f587 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -311,7 +311,7 @@
<para>
To use the <filename>CONFFILES</filename> variable, provide a package name
- override that identifies the package.
+ override that identifies the resulting package.
Then, provide a space-separated list of files.
Here is an example:
<literallayout class='monospaced'>
@@ -622,9 +622,9 @@
<para>
To use the <filename>FILES</filename> variable, provide a package name
- override that identifies the package.
+ override that identifies the resulting package.
Then, provide a space-separated list of files or paths that identifies the
- files you want included as part of the package.
+ files you want included as part of the resulting package.
Here is an example:
<literallayout class='monospaced'>
FILES_${PN} += "${bindir}/mydir1/ ${bindir}/mydir2/myfile"
@@ -1545,11 +1545,17 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2"
<glossentry id='var-PN'><glossterm>PN</glossterm>
<glossdef>
- <para>The recipe name.
+ <para>This variable can have two separate functions depending on the context: a recipe
+ name or a resulting package name.</para>
+ <para><filename>PN</filename> refers to a recipe name in the context of a file used
+ by the OpenEmbedded build system as input to create a package.
The name is normally extracted from the recipe file name.
For example, if the recipe is named
<filename>expat_2.0.1.bb</filename>, then the default value of <filename>PN</filename>
- will be "expat".
+ will be "expat".</para>
+ <para>
+ The variable refers to a package name in the context of a file created or produced by the
+ OpenEmbedded build system.
</para>
</glossdef>
</glossentry>
diff --git a/documentation/poky-ref-manual/technical-details.xml b/documentation/poky-ref-manual/technical-details.xml
index aef1c2792d..ab41a06269 100644
--- a/documentation/poky-ref-manual/technical-details.xml
+++ b/documentation/poky-ref-manual/technical-details.xml
@@ -809,7 +809,7 @@
LICENSE_FLAGS = "commercial"
</literallayout>
Here is a slightly more complicated example that contains both an
- explicit package name and version (after variable expansion):
+ explicit recipe name and version (after variable expansion):
<literallayout class='monospaced'>
LICENSE_FLAGS = "license_${PN}_${PV}"
</literallayout>
@@ -830,7 +830,7 @@
<literallayout class='monospaced'>
LICENSE_FLAGS_WHITELIST = "commercial_gst-plugins-ugly"
</literallayout>
- Likewise, to additionally enable the package containing
+ Likewise, to additionally enable the package built from the recipe containing
<filename>LICENSE_FLAGS = "license_${PN}_${PV}"</filename>, and assuming
that the actual recipe name was <filename>emgd_1.10.bb</filename>,
the following string would enable that package as well as