summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-06-13 13:34:39 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-06-29 14:59:22 +0100
commit22fa92fa14891857956a68b14ac4a7536eacef62 (patch)
tree4c9454e82dc5cdef172eb3712c33395d655aaab6
parenta717c33e5d2f51cdc9d163696ce1f9229a8a3d4b (diff)
downloadpoky-22fa92fa14891857956a68b14ac4a7536eacef62.tar.gz
poky-22fa92fa14891857956a68b14ac4a7536eacef62.tar.bz2
poky-22fa92fa14891857956a68b14ac4a7536eacef62.zip
documentation/poky-ref-manual/ref-variables.xml: 1.1.2 variables and updates
First pass at implementing the poky.ent variables. Also, made some corrections to text. (From yocto-docs rev: c1e7fe4413a611ed4d4a727432a1a4763d308bb3) 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.xml29
1 files changed, 15 insertions, 14 deletions
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index ba74798856..8e4d9df41c 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -1,5 +1,6 @@
<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
-"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
+[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<!-- Dummy chapter -->
<appendix id='ref-variables-glos'>
@@ -75,7 +76,7 @@
<glossentry id='var-BB_NUMBER_THREADS'><glossterm>BB_NUMBER_THREADS</glossterm>
<glossdef>
<para>The maximum number of tasks BitBake should run in parallel at any one time.
- If your host development system supports mulitiple cores a good rule of thumb
+ If your host development system supports multiple cores, a good rule of thumb
is to set this variable to twice the number of cores.</para>
</glossdef>
</glossentry>
@@ -306,8 +307,8 @@
<glossentry id='var-DISTRO_PN_ALIAS'><glossterm>DISTRO_PN_ALIAS</glossterm>
<glossdef>
<para>Alias names used for the recipe in various Linux distributions.</para>
- <para>See <link linkend='usingpoky-configuring-DISTRO_PN_ALIAS'>
- Handling a Package Name Alias</link> section for more information.</para>
+ <para>See "<link linkend='usingpoky-configuring-DISTRO_PN_ALIAS'>
+ Handling a Package Name Alias</link>" section for more information.</para>
</glossdef>
</glossentry>
@@ -446,7 +447,7 @@
The options to pass in
<filename><link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link></filename>
and <filename><link linkend='var-CFLAGS'>CFLAGS</link></filename>
- when compiling an optimised system.
+ when compiling an optimized system.
This variable defaults to
"-fexpensive-optimizations -fomit-frame-pointer -frename-registers -O2".
</para>
@@ -476,7 +477,7 @@
Typically, you configure this variable in image recipes.
Note that you can add extra features to the image by using the
<filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename> variable.
- See the <link linkend="ref-features-image">Reference: Images</link> section for the
+ See the "<link linkend="ref-features-image">Reference: Images</link>" section for the
list of features present in images built by the Yocto Project.</para>
</glossdef>
</glossentry>
@@ -707,7 +708,7 @@
</para>
<para>
This variable is similar to the
- <link linkend='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</link>
+ <filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</link></filename>
variable with the exception that the package being built has a build
dependency on the variable's list of packages.
In other words, the image will not build if a file in this list is not found.
@@ -737,7 +738,7 @@
</para>
<para>
This variable is similar to the
- <link linkend='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</link>
+ <filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</link></filename>
variable with the exception that the package being built does not have a build
dependency on the variable's list of packages.
In other words, the image will build if a file in this list is not found.
@@ -785,7 +786,7 @@
</para>
<para>
This variable is similar to the
- <link linkend='var-MACHINE_EXTRA_RRECOMMENDS'>MACHINE_EXTRA_RRECOMMENDS</link>
+ <filename><link linkend='var-MACHINE_EXTRA_RRECOMMENDS'>MACHINE_EXTRA_RRECOMMENDS</link></filename>
variable with the exception that the package being built has a build
dependency on the variable's list of packages.
In other words, the image will not build if a file in this list is not found.
@@ -822,7 +823,7 @@
</para>
<para>
This variable is similar to the
- <link linkend='var-MACHINE_EXTRA_RDEPENDS'>MACHINE_EXTRA_RDEPENDS</link>
+ <filename><link linkend='var-MACHINE_EXTRA_RDEPENDS'>MACHINE_EXTRA_RDEPENDS</link></filename>
variable with the exception that the package being built does not have a build
dependency on the variable's list of packages.
In other words, the image will build if a file in this list is not found.
@@ -932,7 +933,7 @@
This variable is usually in the form <filename>-j 4</filename>, where the number
represents the maximum number of parallel threads make can run.
If you development host supports multiple cores a good rule of thumb is to set
- this variable to one and a half times the number of cores on the host.</para>
+ this variable to twice the number of cores on the host.</para>
</glossdef>
</glossentry>
@@ -1117,7 +1118,7 @@
The package being built does not depend on this list of packages in
order to successfully build, but needs them for the extended usability.
To specify runtime dependencies for packages, see the
- <link linkend='var-RDEPENDS'>RDEPENDS</link> variable.
+ <filename><link linkend='var-RDEPENDS'>RDEPENDS</link></filename> variable.
</para>
<para>
The Yocto Project build process automatically installs the list of packages
@@ -1160,7 +1161,7 @@
<para>
The path to unpacked sources.
By default, this path is
- "${<link linkend='var-WORKDIR'>WORKDIR</link>}/${<link linkend='var-PN'>PN</link>}-${<link linkend='var-PV'>PV</link>}".
+ "<filename>${<link linkend='var-WORKDIR'>WORKDIR</link>}/${<link linkend='var-PN'>PN</link>}-${<link linkend='var-PV'>PV</link>}</filename>".
</para>
</glossdef>
</glossentry>
@@ -1242,7 +1243,7 @@
contains files that are machine-specific.
If so, the Yocto Project automatically changes
<filename><link linkend='var-PACKAGE_ARCH'>PACKAGE_ARCH</link></filename>.
- Setting this variable to "0" disables this behaviour.
+ Setting this variable to "0" disables this behavior.
</para>
</glossdef>
</glossentry>