documentation/poky-ref-manual/ref-varlocality.xml: Reformatted

This appendix had poor organization.  I re-organized it according
to configuration and recipe context.  The sub-sections break out much
more nicely now.

(From yocto-docs rev: 7a3a7b3a7b4861122194ea0a78c16af531f0078b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

1 files changed, 185 insertions, 191 deletions

diff --git a/documentation/poky-ref-manual/ref-varlocality.xml b/documentation/poky-ref-manual/ref-varlocality.xml
index 21930bf..d3d931b 100644
--- a/documentation/poky-ref-manual/ref-varlocality.xml
+++ b/documentation/poky-ref-manual/ref-varlocality.xml
@@ -2,208 +2,202 @@
 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 
 <appendix id='ref-varlocality'>
-    <title>Reference: Variable Locality (Distro, Machine, Recipe etc.)</title>
+    <title>Reference: Variable Context</title>
 
     <para>
-        Whilst most variables can be used in almost any context (.conf, .bbclass, 
-        .inc or .bb file), variables are often associated with a particular 
-        locality/context. This section describes some common associations.
+        While most variables can be used in almost any context such as 
+        <filename>.conf</filename>, <filename>.bbclass</filename>,
+        <filename>.inc</filename>, and <filename>.bb</filename> files,
+        some variables are often associated with a particular locality or context. 
+        This appendix describes some common associations.
     </para>
 
-    <section id='ref-varlocality-config-distro'>
-        <title>Distro Configuration</title>
-
-        <itemizedlist>
-            <listitem>
-                <para><glossterm linkend='var-DISTRO'><link linkend='var-DISTRO'>DISTRO</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm linkend='var-DISTRO_NAME'><link linkend='var-DISTRO_NAME'>DISTRO_NAME</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm linkend='var-DISTRO_VERSION'><link linkend='var-DISTRO_VERSION'>DISTRO_VERSION</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm linkend='var-MAINTAINER'><link linkend='var-MAINTAINER'>MAINTAINER</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm linkend='var-PACKAGE_CLASSES'><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm linkend='var-TARGET_OS'><link linkend='var-TARGET_OS'>TARGET_OS</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm linkend='var-TARGET_FPU'><link linkend='var-TARGET_FPU'>TARGET_FPU</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm linkend='var-POKYMODE'><link linkend='var-POKYMODE'>POKYMODE</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm linkend='var-POKYLIBC'><link linkend='var-POKYLIBC'>POKYLIBC</link></glossterm></para>
-            </listitem>
-        </itemizedlist>
-    </section>
+    <section id='ref-varlocality-configuration'>
+        <title>Configuration</title>
 
-    <section id='ref-varlocality-config-machine'>
-        <title>Machine Configuration</title>
-
-        <itemizedlist>
-            <listitem>
-                <para><glossterm linkend='var-TARGET_ARCH'><link linkend='var-TARGET_ARCH'>TARGET_ARCH</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm linkend='var-SERIAL_CONSOLE'><link linkend='var-SERIAL_CONSOLE'>SERIAL_CONSOLE</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm linkend='var-PACKAGE_EXTRA_ARCHS'><link linkend='var-PACKAGE_EXTRA_ARCHS'>PACKAGE_EXTRA_ARCHS</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm linkend='var-IMAGE_FSTYPES'><link linkend='var-IMAGE_FSTYPES'>IMAGE_FSTYPES</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm linkend='var-ROOT_FLASH_SIZE'><link linkend='var-ROOT_FLASH_SIZE'>ROOT_FLASH_SIZE</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm linkend='var-MACHINE_FEATURES'><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm linkend='var-MACHINE_EXTRA_RDEPENDS'><link linkend='var-MACHINE_EXTRA_RDEPENDS'>MACHINE_EXTRA_RDEPENDS</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm linkend='var-MACHINE_EXTRA_RRECOMMENDS'><link linkend='var-MACHINE_EXTRA_RRECOMMENDS'>MACHINE_EXTRA_RRECOMMENDS</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm linkend='var-MACHINE_ESSENTIAL_RDEPENDS'><link linkend='var-MACHINE_ESSENTIAL_RDEPENDS'>MACHINE_ESSENTIAL_RDEPENDS</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm linkend='var-MACHINE_ESSENTIAL_RRECOMMENDS'><link linkend='var-MACHINE_ESSENTIAL_RRECOMMENDS'>MACHINE_ESSENTIAL_RRECOMMENDS</link></glossterm></para>
-            </listitem>
-        </itemizedlist>
-    </section>
+        <para>
+            The following subsections provide lists of variables whose context is
+            configuration: distribution, machine, and local.
+        </para>
 
-    <section id='ref-varlocality-config-local'>
-        <title>Local Configuration (local.conf)</title>
-        <itemizedlist>
-            <listitem>
-                <para><glossterm linkend='var-DISTRO'><link linkend='var-DISTRO'>DISTRO</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm linkend='var-MACHINE'><link linkend='var-MACHINE'>MACHINE</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm linkend='var-DL_DIR'><link linkend='var-DL_DIR'>DL_DIR</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm linkend='var-BBFILES'><link linkend='var-BBFILES'>BBFILES</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm linkend='var-EXTRA_IMAGE_FEATURES'><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm linkend='var-PACKAGE_CLASSES'><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm linkend='var-BB_NUMBER_THREADS'><link linkend='var-BB_NUMBER_THREADS'>BB_NUMBER_THREADS</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm linkend='var-BBINCLUDELOGS'><link linkend='var-BBINCLUDELOGS'>BBINCLUDELOGS</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm linkend='var-ENABLE_BINARY_LOCALE_GENERATION'><link linkend='var-ENABLE_BINARY_LOCALE_GENERATION'>ENABLE_BINARY_LOCALE_GENERATION</link></glossterm></para>
-            </listitem>
-        </itemizedlist>
-    </section>
+        <section id='ref-varlocality-config-distro'>
+            <title>Distribution (Distro)</title>
 
-    <section id='ref-varlocality-recipe-required'>
-        <title>Recipe Variables - Required</title>
-
-        <itemizedlist>
-            <listitem>
-                <para><glossterm><link linkend='var-DESCRIPTION'>DESCRIPTION</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm><link linkend='var-LICENSE'>LICENSE</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm><link linkend='var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm><link linkend='var-SECTION'>SECTION</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm><link linkend='var-HOMEPAGE'>HOMEPAGE</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm><link linkend='var-AUTHOR'>AUTHOR</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm><link linkend='var-SRC_URI'>SRC_URI</link></glossterm></para>
-            </listitem>
-        </itemizedlist>
-    </section>
+            <para>
+               This section lists variables whose context is the distribution, or distro.
+               <itemizedlist>
+                   <listitem><para><filename><link linkend='var-DISTRO'>DISTRO</link></filename></para></listitem>
+                   <listitem><para><filename><link linkend='var-DISTRO_NAME'>DISTRO_NAME</link></filename>
+                       </para></listitem>
+                   <listitem><para><filename><link linkend='var-DISTRO_VERSION'>DISTRO_VERSION</link>
+                       </filename></para></listitem>
+                   <listitem><para><filename><link linkend='var-MAINTAINER'>MAINTAINER</link></filename>
+                       </para></listitem>
+                   <listitem><para><filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link>
+                       </filename></para></listitem>
+                   <listitem><para><filename><link linkend='var-TARGET_OS'>TARGET_OS</link></filename>
+                       </para></listitem>
+                   <listitem><para><filename><link linkend='var-TARGET_FPU'>TARGET_FPU</link></filename>
+                       </para></listitem>
+                   <listitem><para><filename><link linkend='var-POKYMODE'>POKYMODE</link></filename>
+                       </para></listitem>
+                   <listitem><para><filename><link linkend='var-TCMODE'>TCMODE</link></filename>
+                       </para></listitem>
+                   <listitem><para><filename><link linkend='var-POKYLIBC'>POKYLIBC</link></filename>
+                       </para></listitem>
+                </itemizedlist>
+            </para>
+        </section>
 
-    <section id='ref-varlocality-recipe-dependencies'>
-        <title>Recipe Variables - Dependencies</title>
-
-        <itemizedlist>
-            <listitem>
-                <para><glossterm><link linkend='var-DEPENDS'>DEPENDS</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm><link linkend='var-RDEPENDS'>RDEPENDS</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm><link linkend='var-RRECOMMENDS'>RRECOMMENDS</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm><link linkend='var-RCONFLICTS'>RCONFLICTS</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm><link linkend='var-RREPLACES'>RREPLACES</link></glossterm></para>
-            </listitem>
-        </itemizedlist>
-    </section>
+        <section id='ref-varlocality-config-machine'>
+            <title>Machine</title>
+
+            <para>
+                This section lists variables whose context is the machine.
+                <itemizedlist>
+                    <listitem><para><filename><link linkend='var-TARGET_ARCH'>TARGET_ARCH</link></filename>
+                        </para></listitem>
+                    <listitem><para><filename><link linkend='var-SERIAL_CONSOLE'>SERIAL_CONSOLE</link>
+                        </filename></para></listitem>
+                    <listitem><para><filename><link linkend='var-PACKAGE_EXTRA_ARCHS'>PACKAGE_EXTRA_ARCHS</link>
+                        </filename></para></listitem>
+                    <listitem><para><filename><link linkend='var-IMAGE_FSTYPES'>IMAGE_FSTYPES</link>
+                        </filename></para></listitem>
+                    <listitem><para><filename><link linkend='var-ROOT_FLASH_SIZE'>ROOT_FLASH_SIZE</link>
+                        </filename></para></listitem>
+                    <listitem><para><filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link>
+                        </filename></para></listitem>
+                    <listitem><para><filename><link linkend='var-MACHINE_EXTRA_RDEPENDS'>MACHINE_EXTRA_RDEPENDS
+                        </link></filename></para></listitem>
+                    <listitem><para><filename><link linkend='var-MACHINE_EXTRA_RRECOMMENDS'>MACHINE_EXTRA_RRECOMMENDS
+                        </link></filename></para></listitem>
+                    <listitem><para><filename><link linkend='var-MACHINE_ESSENTIAL_RDEPENDS'>MACHINE_ESSENTIAL_RDEPENDS
+                        </link></filename></para></listitem>
+                    <listitem><para><filename><link linkend='var-MACHINE_ESSENTIAL_RRECOMMENDS'>
+                        MACHINE_ESSENTIAL_RRECOMMENDS</link></filename></para></listitem>
+                </itemizedlist>
+            </para>
+        </section>
 
-    <section id='ref-varlocality-recipe-paths'>
-        <title>Recipe Variables - Paths</title>
-
-        <itemizedlist>
-            <listitem>
-                <para><glossterm><link linkend='var-WORKDIR'>WORKDIR</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm><link linkend='var-S'>S</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm><link linkend='var-FILES'>FILES</link></glossterm></para>
-            </listitem>
-        </itemizedlist>
+        <section id='ref-varlocality-config-local'>
+            <title>Local</title>
+
+            <para>
+                This section lists variables whose context is the local configuration through the 
+                <filename>local.conf</filename> file.
+                <itemizedlist>
+                    <listitem><para><filename><link linkend='var-DISTRO'>DISTRO</link></filename>
+                        </para></listitem>
+                    <listitem><para><filename><link linkend='var-MACHINE'>MACHINE</link></filename>
+                        </para></listitem>
+                    <listitem><para><filename><link linkend='var-DL_DIR'>DL_DIR</link></filename>
+                        </para></listitem>
+                    <listitem><para><filename><link linkend='var-BBFILES'>BBFILES</link></filename>
+                        </para></listitem>
+                    <listitem><para><filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES
+                        </link></filename></para></listitem>
+                    <listitem><para><filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link>
+                        </filename></para></listitem>
+                    <listitem><para><filename><link linkend='var-BB_NUMBER_THREADS'>BB_NUMBER_THREADS</link>
+                        </filename></para></listitem>
+                    <listitem><para><filename><link linkend='var-BBINCLUDELOGS'>BBINCLUDELOGS</link>
+                        </filename></para></listitem>
+                    <listitem><para><filename><link linkend='var-ENABLE_BINARY_LOCALE_GENERATION'>
+                        ENABLE_BINARY_LOCALE_GENERATION</link></filename></para></listitem>
+                </itemizedlist>
+            </para>
+        </section>
     </section>
 
-    <section id='ref-varlocality-recipe-build'>
-        <title>Recipe Variables - Extra Build Information</title>
-
-        <itemizedlist>
-            <listitem>
-                <para><glossterm><link
-                linkend='var-DISTRO_PN_ALIAS'>DISTRO_PN_ALIAS</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm><link linkend='var-EXTRA_OECMAKE'>EXTRA_OECMAKE</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm><link linkend='var-EXTRA_OECONF'>EXTRA_OECONF</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm><link linkend='var-EXTRA_OEMAKE'>EXTRA_OEMAKE</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm><link linkend='var-PACKAGES'>PACKAGES</link></glossterm></para>
-            </listitem>
-            <listitem>
-                <para><glossterm><link linkend='var-DEFAULT_PREFERENCE'>DEFAULT_PREFERENCE</link></glossterm></para>
-            </listitem>
-        </itemizedlist>
+    <section id='ref-varlocality-recipes'>
+        <title>Recipes</title>
+
+        <para>
+            The following subsections provide lists of variables whose context is
+            recipes: required, dependencies, path, and extra build information.
+        </para>
+
+        <section id='ref-varlocality-recipe-required'>
+            <title>Required</title>
+
+            <para>
+                This section lists variables that are required for recipes.
+                <itemizedlist>
+                    <listitem><para><filename><link linkend='var-DESCRIPTION'>DESCRIPTION</link>
+                        </filename></para></listitem>
+                    <listitem><para><filename><link linkend='var-LICENSE'>LICENSE</link>
+                        </filename></para></listitem>
+                    <listitem><para><filename><link linkend='var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</link>
+                        </filename></para></listitem>
+                    <listitem><para><filename><link linkend='var-SECTION'>SECTION</link>
+                        </filename></para></listitem>
+                    <listitem><para><filename><link linkend='var-HOMEPAGE'>HOMEPAGE</link>
+                        </filename></para></listitem>
+                    <listitem><para><filename><link linkend='var-AUTHOR'>AUTHOR</link>
+                        </filename></para></listitem>
+                    <listitem><para><filename><link linkend='var-SRC_URI'>SRC_URI</link>
+                        </filename></para></listitem>
+                </itemizedlist>
+            </para>
+        </section>
+
+        <section id='ref-varlocality-recipe-dependencies'>
+            <title>Dependencies</title>
+
+            <para>
+                This section lists variables that define recipe dependencies.
+                <itemizedlist>
+                    <listitem><para><filename><link linkend='var-DEPENDS'>DEPENDS</link>
+                        </filename></para></listitem>
+                    <listitem><para><filename><link linkend='var-RDEPENDS'>RDEPENDS</link>
+                        </filename></para></listitem>
+                    <listitem><para><filename><link linkend='var-RRECOMMENDS'>RRECOMMENDS</link>
+                        </filename></para></listitem>
+                    <listitem><para><filename><link linkend='var-RCONFLICTS'>RCONFLICTS</link>
+                        </filename></para></listitem>
+                    <listitem><para><filename><link linkend='var-RREPLACES'>RREPLACES</link>
+                        </filename></para></listitem>
+                </itemizedlist>
+            </para>
+        </section>
+
+        <section id='ref-varlocality-recipe-paths'>
+            <title>Paths</title>
+
+            <para>
+                This section lists variables that define recipe paths.
+                <itemizedlist>
+                    <listitem><para><filename><link linkend='var-WORKDIR'>WORKDIR</link>
+                        </filename></para></listitem>
+                    <listitem><para><filename><link linkend='var-S'>S</link>
+                        </filename></para></listitem>
+                    <listitem><para><filename><link linkend='var-FILES'>FILES</link>
+                        </filename></para></listitem>
+                </itemizedlist>
+            </para>
+        </section>
+
+        <section id='ref-varlocality-recipe-build'>
+            <title>Extra Build Information</title>
+
+            <para>
+                This section lists variables that define extra build information for recipes.
+                <itemizedlist>
+                    <listitem><para><filename><link linkend='var-DISTRO_PN_ALIAS'>DISTRO_PN_ALIAS</link>
+                        </filename></para></listitem>
+                    <listitem><para><filename><link linkend='var-EXTRA_OECMAKE'>EXTRA_OECMAKE</link>
+                        </filename></para></listitem>
+                    <listitem><para><filename><link linkend='var-EXTRA_OECONF'>EXTRA_OECONF</link>
+                        </filename></para></listitem>
+                    <listitem><para><filename><link linkend='var-EXTRA_OEMAKE'>EXTRA_OEMAKE</link>
+                        </filename></para></listitem>
+                    <listitem><para><filename><link linkend='var-PACKAGES'>PACKAGES</link></filename>
+                        </para></listitem>
+                    <listitem><para><filename><link linkend='var-DEFAULT_PREFERENCE'>DEFAULT_PREFERENCE
+                        </link></filename></para></listitem>
+                </itemizedlist>
+            </para>
+        </section>
     </section>
 </appendix>
 <!--