summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-06-13 20:34:39 (GMT)
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-06-29 13:59:22 (GMT)
commit22fa92fa14891857956a68b14ac4a7536eacef62 (patch)
tree4c9454e82dc5cdef172eb3712c33395d655aaab6
parenta717c33e5d2f51cdc9d163696ce1f9229a8a3d4b (diff)
downloadpoky-22fa92fa14891857956a68b14ac4a7536eacef62.tar.gz
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 ba74798..8e4d9df 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -1,5 +1,6 @@
1<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 1<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
3 4
4<!-- Dummy chapter --> 5<!-- Dummy chapter -->
5<appendix id='ref-variables-glos'> 6<appendix id='ref-variables-glos'>
@@ -75,7 +76,7 @@
75 <glossentry id='var-BB_NUMBER_THREADS'><glossterm>BB_NUMBER_THREADS</glossterm> 76 <glossentry id='var-BB_NUMBER_THREADS'><glossterm>BB_NUMBER_THREADS</glossterm>
76 <glossdef> 77 <glossdef>
77 <para>The maximum number of tasks BitBake should run in parallel at any one time. 78 <para>The maximum number of tasks BitBake should run in parallel at any one time.
78 If your host development system supports mulitiple cores a good rule of thumb 79 If your host development system supports multiple cores, a good rule of thumb
79 is to set this variable to twice the number of cores.</para> 80 is to set this variable to twice the number of cores.</para>
80 </glossdef> 81 </glossdef>
81 </glossentry> 82 </glossentry>
@@ -306,8 +307,8 @@
306 <glossentry id='var-DISTRO_PN_ALIAS'><glossterm>DISTRO_PN_ALIAS</glossterm> 307 <glossentry id='var-DISTRO_PN_ALIAS'><glossterm>DISTRO_PN_ALIAS</glossterm>
307 <glossdef> 308 <glossdef>
308 <para>Alias names used for the recipe in various Linux distributions.</para> 309 <para>Alias names used for the recipe in various Linux distributions.</para>
309 <para>See <link linkend='usingpoky-configuring-DISTRO_PN_ALIAS'> 310 <para>See "<link linkend='usingpoky-configuring-DISTRO_PN_ALIAS'>
310 Handling a Package Name Alias</link> section for more information.</para> 311 Handling a Package Name Alias</link>" section for more information.</para>
311 </glossdef> 312 </glossdef>
312 </glossentry> 313 </glossentry>
313 314
@@ -446,7 +447,7 @@
446 The options to pass in 447 The options to pass in
447 <filename><link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link></filename> 448 <filename><link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link></filename>
448 and <filename><link linkend='var-CFLAGS'>CFLAGS</link></filename> 449 and <filename><link linkend='var-CFLAGS'>CFLAGS</link></filename>
449 when compiling an optimised system. 450 when compiling an optimized system.
450 This variable defaults to 451 This variable defaults to
451 "-fexpensive-optimizations -fomit-frame-pointer -frename-registers -O2". 452 "-fexpensive-optimizations -fomit-frame-pointer -frename-registers -O2".
452 </para> 453 </para>
@@ -476,7 +477,7 @@
476 Typically, you configure this variable in image recipes. 477 Typically, you configure this variable in image recipes.
477 Note that you can add extra features to the image by using the 478 Note that you can add extra features to the image by using the
478 <filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename> variable. 479 <filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename> variable.
479 See the <link linkend="ref-features-image">Reference: Images</link> section for the 480 See the "<link linkend="ref-features-image">Reference: Images</link>" section for the
480 list of features present in images built by the Yocto Project.</para> 481 list of features present in images built by the Yocto Project.</para>
481 </glossdef> 482 </glossdef>
482 </glossentry> 483 </glossentry>
@@ -707,7 +708,7 @@
707 </para> 708 </para>
708 <para> 709 <para>
709 This variable is similar to the 710 This variable is similar to the
710 <link linkend='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</link> 711 <filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</link></filename>
711 variable with the exception that the package being built has a build 712 variable with the exception that the package being built has a build
712 dependency on the variable's list of packages. 713 dependency on the variable's list of packages.
713 In other words, the image will not build if a file in this list is not found. 714 In other words, the image will not build if a file in this list is not found.
@@ -737,7 +738,7 @@
737 </para> 738 </para>
738 <para> 739 <para>
739 This variable is similar to the 740 This variable is similar to the
740 <link linkend='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</link> 741 <filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</link></filename>
741 variable with the exception that the package being built does not have a build 742 variable with the exception that the package being built does not have a build
742 dependency on the variable's list of packages. 743 dependency on the variable's list of packages.
743 In other words, the image will build if a file in this list is not found. 744 In other words, the image will build if a file in this list is not found.
@@ -785,7 +786,7 @@
785 </para> 786 </para>
786 <para> 787 <para>
787 This variable is similar to the 788 This variable is similar to the
788 <link linkend='var-MACHINE_EXTRA_RRECOMMENDS'>MACHINE_EXTRA_RRECOMMENDS</link> 789 <filename><link linkend='var-MACHINE_EXTRA_RRECOMMENDS'>MACHINE_EXTRA_RRECOMMENDS</link></filename>
789 variable with the exception that the package being built has a build 790 variable with the exception that the package being built has a build
790 dependency on the variable's list of packages. 791 dependency on the variable's list of packages.
791 In other words, the image will not build if a file in this list is not found. 792 In other words, the image will not build if a file in this list is not found.
@@ -822,7 +823,7 @@
822 </para> 823 </para>
823 <para> 824 <para>
824 This variable is similar to the 825 This variable is similar to the
825 <link linkend='var-MACHINE_EXTRA_RDEPENDS'>MACHINE_EXTRA_RDEPENDS</link> 826 <filename><link linkend='var-MACHINE_EXTRA_RDEPENDS'>MACHINE_EXTRA_RDEPENDS</link></filename>
826 variable with the exception that the package being built does not have a build 827 variable with the exception that the package being built does not have a build
827 dependency on the variable's list of packages. 828 dependency on the variable's list of packages.
828 In other words, the image will build if a file in this list is not found. 829 In other words, the image will build if a file in this list is not found.
@@ -932,7 +933,7 @@
932 This variable is usually in the form <filename>-j 4</filename>, where the number 933 This variable is usually in the form <filename>-j 4</filename>, where the number
933 represents the maximum number of parallel threads make can run. 934 represents the maximum number of parallel threads make can run.
934 If you development host supports multiple cores a good rule of thumb is to set 935 If you development host supports multiple cores a good rule of thumb is to set
935 this variable to one and a half times the number of cores on the host.</para> 936 this variable to twice the number of cores on the host.</para>
936 </glossdef> 937 </glossdef>
937 </glossentry> 938 </glossentry>
938 939
@@ -1117,7 +1118,7 @@
1117 The package being built does not depend on this list of packages in 1118 The package being built does not depend on this list of packages in
1118 order to successfully build, but needs them for the extended usability. 1119 order to successfully build, but needs them for the extended usability.
1119 To specify runtime dependencies for packages, see the 1120 To specify runtime dependencies for packages, see the
1120 <link linkend='var-RDEPENDS'>RDEPENDS</link> variable. 1121 <filename><link linkend='var-RDEPENDS'>RDEPENDS</link></filename> variable.
1121 </para> 1122 </para>
1122 <para> 1123 <para>
1123 The Yocto Project build process automatically installs the list of packages 1124 The Yocto Project build process automatically installs the list of packages
@@ -1160,7 +1161,7 @@
1160 <para> 1161 <para>
1161 The path to unpacked sources. 1162 The path to unpacked sources.
1162 By default, this path is 1163 By default, this path is
1163 "${<link linkend='var-WORKDIR'>WORKDIR</link>}/${<link linkend='var-PN'>PN</link>}-${<link linkend='var-PV'>PV</link>}". 1164 "<filename>${<link linkend='var-WORKDIR'>WORKDIR</link>}/${<link linkend='var-PN'>PN</link>}-${<link linkend='var-PV'>PV</link>}</filename>".
1164 </para> 1165 </para>
1165 </glossdef> 1166 </glossdef>
1166 </glossentry> 1167 </glossentry>
@@ -1242,7 +1243,7 @@
1242 contains files that are machine-specific. 1243 contains files that are machine-specific.
1243 If so, the Yocto Project automatically changes 1244 If so, the Yocto Project automatically changes
1244 <filename><link linkend='var-PACKAGE_ARCH'>PACKAGE_ARCH</link></filename>. 1245 <filename><link linkend='var-PACKAGE_ARCH'>PACKAGE_ARCH</link></filename>.
1245 Setting this variable to "0" disables this behaviour. 1246 Setting this variable to "0" disables this behavior.
1246 </para> 1247 </para>
1247 </glossdef> 1248 </glossdef>
1248 </glossentry> 1249 </glossentry>