From 94638de796987255016e04c91fbb4ea93fbe4700 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Tue, 23 Aug 2011 13:49:07 -0700 Subject: 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 Signed-off-by: Richard Purdie --- documentation/poky-ref-manual/ref-varlocality.xml | 376 +++++++++++----------- 1 file changed, 185 insertions(+), 191 deletions(-) (limited to 'documentation') diff --git a/documentation/poky-ref-manual/ref-varlocality.xml b/documentation/poky-ref-manual/ref-varlocality.xml index 21930bf8b6..d3d931b4d0 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"> - Reference: Variable Locality (Distro, Machine, Recipe etc.) + Reference: Variable Context - 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 + .conf, .bbclass, + .inc, and .bb files, + some variables are often associated with a particular locality or context. + This appendix describes some common associations. -
- Distro Configuration - - - - DISTRO - - - DISTRO_NAME - - - DISTRO_VERSION - - - MAINTAINER - - - PACKAGE_CLASSES - - - TARGET_OS - - - TARGET_FPU - - - POKYMODE - - - POKYLIBC - - -
+
+ Configuration -
- Machine Configuration - - - - TARGET_ARCH - - - SERIAL_CONSOLE - - - PACKAGE_EXTRA_ARCHS - - - IMAGE_FSTYPES - - - ROOT_FLASH_SIZE - - - MACHINE_FEATURES - - - MACHINE_EXTRA_RDEPENDS - - - MACHINE_EXTRA_RRECOMMENDS - - - MACHINE_ESSENTIAL_RDEPENDS - - - MACHINE_ESSENTIAL_RRECOMMENDS - - -
+ + The following subsections provide lists of variables whose context is + configuration: distribution, machine, and local. + -
- Local Configuration (local.conf) - - - DISTRO - - - MACHINE - - - DL_DIR - - - BBFILES - - - EXTRA_IMAGE_FEATURES - - - PACKAGE_CLASSES - - - BB_NUMBER_THREADS - - - BBINCLUDELOGS - - - ENABLE_BINARY_LOCALE_GENERATION - - -
+
+ Distribution (Distro) -
- Recipe Variables - Required - - - - DESCRIPTION - - - LICENSE - - - LIC_FILES_CHKSUM - - - SECTION - - - HOMEPAGE - - - AUTHOR - - - SRC_URI - - -
+ + This section lists variables whose context is the distribution, or distro. + + DISTRO + DISTRO_NAME + + DISTRO_VERSION + + MAINTAINER + + PACKAGE_CLASSES + + TARGET_OS + + TARGET_FPU + + POKYMODE + + TCMODE + + POKYLIBC + + + +
-
- Recipe Variables - Dependencies - - - - DEPENDS - - - RDEPENDS - - - RRECOMMENDS - - - RCONFLICTS - - - RREPLACES - - -
+
+ Machine + + + This section lists variables whose context is the machine. + + TARGET_ARCH + + SERIAL_CONSOLE + + PACKAGE_EXTRA_ARCHS + + IMAGE_FSTYPES + + ROOT_FLASH_SIZE + + MACHINE_FEATURES + + MACHINE_EXTRA_RDEPENDS + + MACHINE_EXTRA_RRECOMMENDS + + MACHINE_ESSENTIAL_RDEPENDS + + + MACHINE_ESSENTIAL_RRECOMMENDS + + +
-
- Recipe Variables - Paths - - - - WORKDIR - - - S - - - FILES - - +
+ Local + + + This section lists variables whose context is the local configuration through the + local.conf file. + + DISTRO + + MACHINE + + DL_DIR + + BBFILES + + EXTRA_IMAGE_FEATURES + + PACKAGE_CLASSES + + BB_NUMBER_THREADS + + BBINCLUDELOGS + + + ENABLE_BINARY_LOCALE_GENERATION + + +
-
- Recipe Variables - Extra Build Information - - - - DISTRO_PN_ALIAS - - - EXTRA_OECMAKE - - - EXTRA_OECONF - - - EXTRA_OEMAKE - - - PACKAGES - - - DEFAULT_PREFERENCE - - +
+ Recipes + + + The following subsections provide lists of variables whose context is + recipes: required, dependencies, path, and extra build information. + + +
+ Required + + + This section lists variables that are required for recipes. + + DESCRIPTION + + LICENSE + + LIC_FILES_CHKSUM + + SECTION + + HOMEPAGE + + AUTHOR + + SRC_URI + + + +
+ +
+ Dependencies + + + This section lists variables that define recipe dependencies. + + DEPENDS + + RDEPENDS + + RRECOMMENDS + + RCONFLICTS + + RREPLACES + + + +
+ +
+ Paths + + + This section lists variables that define recipe paths. + + WORKDIR + + S + + FILES + + + +
+ +
+ Extra Build Information + + + This section lists variables that define extra build information for recipes. + + DISTRO_PN_ALIAS + + EXTRA_OECMAKE + + EXTRA_OECONF + + EXTRA_OEMAKE + + PACKAGES + + DEFAULT_PREFERENCE + + + +