]> git.ipfire.org Git - thirdparty/openembedded/openembedded-core-contrib.git/commitdiff
documentation/poky-ref-manual: PN scrub
authorScott Rifenbark <scott.m.rifenbark@intel.com>
Thu, 20 Sep 2012 20:47:34 +0000 (13:47 -0700)
committerRichard Purdie <richard.purdie@linuxfoundation.org>
Mon, 24 Sep 2012 15:36:07 +0000 (16:36 +0100)
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>
documentation/poky-ref-manual/ref-variables.xml
documentation/poky-ref-manual/technical-details.xml

index 1ef8163c6ee83f404807e1ddd7dc472c99e11b84..9caa51f5870575e2490837313e0b33877e581d94 100644 (file)
 
                 <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'>                       
 
                 <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>
index aef1c2792d40dade8ec8e6824ac555679b3ecab9..ab41a06269bd17a4f41c4c5630addc7bb35dfff4 100644 (file)
      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>
             <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