diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2012-09-20 13:47:34 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2012-09-24 16:36:07 +0100 |
commit | 19bd5f07256276e40edf62b2447c3ca3a3914cab (patch) | |
tree | 7e5fc09fd7f6256a724df30b35bbff67f46de94b /documentation/poky-ref-manual | |
parent | 35abb93edfae4d16143008eb100fca7e2cf21296 (diff) | |
download | poky-19bd5f07256276e40edf62b2447c3ca3a3914cab.tar.gz |
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>
Diffstat (limited to 'documentation/poky-ref-manual')
-rw-r--r-- | documentation/poky-ref-manual/ref-variables.xml | 16 | ||||
-rw-r--r-- | documentation/poky-ref-manual/technical-details.xml | 4 |
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 @@ | |||
311 | 311 | ||
312 | <para> | 312 | <para> |
313 | To use the <filename>CONFFILES</filename> variable, provide a package name | 313 | To use the <filename>CONFFILES</filename> variable, provide a package name |
314 | override that identifies the package. | 314 | override that identifies the resulting package. |
315 | Then, provide a space-separated list of files. | 315 | Then, provide a space-separated list of files. |
316 | Here is an example: | 316 | Here is an example: |
317 | <literallayout class='monospaced'> | 317 | <literallayout class='monospaced'> |
@@ -622,9 +622,9 @@ | |||
622 | 622 | ||
623 | <para> | 623 | <para> |
624 | To use the <filename>FILES</filename> variable, provide a package name | 624 | To use the <filename>FILES</filename> variable, provide a package name |
625 | override that identifies the package. | 625 | override that identifies the resulting package. |
626 | Then, provide a space-separated list of files or paths that identifies the | 626 | Then, provide a space-separated list of files or paths that identifies the |
627 | files you want included as part of the package. | 627 | files you want included as part of the resulting package. |
628 | Here is an example: | 628 | Here is an example: |
629 | <literallayout class='monospaced'> | 629 | <literallayout class='monospaced'> |
630 | FILES_${PN} += "${bindir}/mydir1/ ${bindir}/mydir2/myfile" | 630 | FILES_${PN} += "${bindir}/mydir1/ ${bindir}/mydir2/myfile" |
@@ -1545,11 +1545,17 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2" | |||
1545 | 1545 | ||
1546 | <glossentry id='var-PN'><glossterm>PN</glossterm> | 1546 | <glossentry id='var-PN'><glossterm>PN</glossterm> |
1547 | <glossdef> | 1547 | <glossdef> |
1548 | <para>The recipe name. | 1548 | <para>This variable can have two separate functions depending on the context: a recipe |
1549 | name or a resulting package name.</para> | ||
1550 | <para><filename>PN</filename> refers to a recipe name in the context of a file used | ||
1551 | by the OpenEmbedded build system as input to create a package. | ||
1549 | The name is normally extracted from the recipe file name. | 1552 | The name is normally extracted from the recipe file name. |
1550 | For example, if the recipe is named | 1553 | For example, if the recipe is named |
1551 | <filename>expat_2.0.1.bb</filename>, then the default value of <filename>PN</filename> | 1554 | <filename>expat_2.0.1.bb</filename>, then the default value of <filename>PN</filename> |
1552 | will be "expat". | 1555 | will be "expat".</para> |
1556 | <para> | ||
1557 | The variable refers to a package name in the context of a file created or produced by the | ||
1558 | OpenEmbedded build system. | ||
1553 | </para> | 1559 | </para> |
1554 | </glossdef> | 1560 | </glossdef> |
1555 | </glossentry> | 1561 | </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 @@ | |||
809 | LICENSE_FLAGS = "commercial" | 809 | LICENSE_FLAGS = "commercial" |
810 | </literallayout> | 810 | </literallayout> |
811 | Here is a slightly more complicated example that contains both an | 811 | Here is a slightly more complicated example that contains both an |
812 | explicit package name and version (after variable expansion): | 812 | explicit recipe name and version (after variable expansion): |
813 | <literallayout class='monospaced'> | 813 | <literallayout class='monospaced'> |
814 | LICENSE_FLAGS = "license_${PN}_${PV}" | 814 | LICENSE_FLAGS = "license_${PN}_${PV}" |
815 | </literallayout> | 815 | </literallayout> |
@@ -830,7 +830,7 @@ | |||
830 | <literallayout class='monospaced'> | 830 | <literallayout class='monospaced'> |
831 | LICENSE_FLAGS_WHITELIST = "commercial_gst-plugins-ugly" | 831 | LICENSE_FLAGS_WHITELIST = "commercial_gst-plugins-ugly" |
832 | </literallayout> | 832 | </literallayout> |
833 | Likewise, to additionally enable the package containing | 833 | Likewise, to additionally enable the package built from the recipe containing |
834 | <filename>LICENSE_FLAGS = "license_${PN}_${PV}"</filename>, and assuming | 834 | <filename>LICENSE_FLAGS = "license_${PN}_${PV}"</filename>, and assuming |
835 | that the actual recipe name was <filename>emgd_1.10.bb</filename>, | 835 | that the actual recipe name was <filename>emgd_1.10.bb</filename>, |
836 | the following string would enable that package as well as | 836 | the following string would enable that package as well as |