summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-03-15 15:33:08 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-03-23 14:24:48 +0000
commitf99aa9453e93f4aa0a1f9382f2c28acb33df6d40 (patch)
tree298b16e9d54da559cab78d135f9b5c7b0869d9fb
parent542d163b5c203ed08e00a71aaac7e7e60cdd9af6 (diff)
downloadpoky-f99aa9453e93f4aa0a1f9382f2c28acb33df6d40.tar.gz
documentation/poky-ref-manual/ref-variables.xml: New ALLOW_EMPTY variable
Created a new glossary entry for the variable ALLOW_EMPTY. (From yocto-docs rev: 35e3693c9f6b3f2842cfde55703a1fa1d1f27345) 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.xml31
1 files changed, 26 insertions, 5 deletions
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index d2b96048b2..f345a9ee72 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -16,7 +16,7 @@
16 16
17 17
18 <para> 18 <para>
19 <link linkend='var-AUTHOR'>A</link> 19 <link linkend='var-ALLOW_EMPTY'>A</link>
20 <link linkend='var-B'>B</link> 20 <link linkend='var-B'>B</link>
21 <link linkend='var-CFLAGS'>C</link> 21 <link linkend='var-CFLAGS'>C</link>
22 <link linkend='var-D'>D</link> 22 <link linkend='var-D'>D</link>
@@ -46,6 +46,27 @@
46 46
47 <glossdiv id='var-glossary-a'><title>A</title> 47 <glossdiv id='var-glossary-a'><title>A</title>
48 48
49 <glossentry id='var-ALLOW_EMPTY'><glossterm>ALLOW_EMPTY</glossterm>
50 <glossdef>
51 <para>
52 Specifies if an output package should still be produced if it is empty.
53 By default, BitBake does not produce empty packages.
54 This default behavior can cause issues when there is an
55 <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> or
56 some other runtime hard-requirement on the existence of the package.
57 </para>
58
59 <para>
60 Like all package-controlling variables, you must always use them in
61 conjunction with a package name override.
62 Here is an example:
63 <literallayout class='monospaced'>
64 ALLOW_EMPTY_${PN}
65 </literallayout>
66 </para>
67 </glossdef>
68 </glossentry>
69
49 <glossentry id='var-AUTHOR'><glossterm>AUTHOR</glossterm> 70 <glossentry id='var-AUTHOR'><glossterm>AUTHOR</glossterm>
50 <glossdef> 71 <glossdef>
51 <para>The email address used to contact the original author or authors in 72 <para>The email address used to contact the original author or authors in
@@ -146,7 +167,7 @@
146 <glossentry id='var-BB_NUMBER_THREADS'><glossterm>BB_NUMBER_THREADS</glossterm> 167 <glossentry id='var-BB_NUMBER_THREADS'><glossterm>BB_NUMBER_THREADS</glossterm>
147 <glossdef> 168 <glossdef>
148 <para>The maximum number of tasks BitBake should run in parallel at any one time. 169 <para>The maximum number of tasks BitBake should run in parallel at any one time.
149 If your host development system supports mulitiple cores a good rule of thumb 170 If your host development system supports multiple cores a good rule of thumb
150 is to set this variable to twice the number of cores.</para> 171 is to set this variable to twice the number of cores.</para>
151 </glossdef> 172 </glossdef>
152 </glossentry> 173 </glossentry>
@@ -638,7 +659,7 @@
638 the immediate expansion (<filename>:=</filename>) operator as shown in the 659 the immediate expansion (<filename>:=</filename>) operator as shown in the
639 previous example. 660 previous example.
640 Finally, to maintain the integrity of the <filename>FILESPATH</filename> variable, 661 Finally, to maintain the integrity of the <filename>FILESPATH</filename> variable,
641 you must inclued the appropriate beginning or ending (as needed) colon character. 662 you must include the appropriate beginning or ending (as needed) colon character.
642 </para> 663 </para>
643 664
644 <para> 665 <para>
@@ -718,7 +739,7 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
718 The options to pass in 739 The options to pass in
719 <filename><link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link></filename> 740 <filename><link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link></filename>
720 and <filename><link linkend='var-CFLAGS'>CFLAGS</link></filename> 741 and <filename><link linkend='var-CFLAGS'>CFLAGS</link></filename>
721 when compiling an optimised system. 742 when compiling an optimized system.
722 This variable defaults to 743 This variable defaults to
723 "-fexpensive-optimizations -fomit-frame-pointer -frename-registers -O2". 744 "-fexpensive-optimizations -fomit-frame-pointer -frename-registers -O2".
724 </para> 745 </para>
@@ -1682,7 +1703,7 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
1682 contains files that are machine-specific. 1703 contains files that are machine-specific.
1683 If so, the Yocto Project automatically changes 1704 If so, the Yocto Project automatically changes
1684 <filename><link linkend='var-PACKAGE_ARCH'>PACKAGE_ARCH</link></filename>. 1705 <filename><link linkend='var-PACKAGE_ARCH'>PACKAGE_ARCH</link></filename>.
1685 Setting this variable to "0" disables this behaviour. 1706 Setting this variable to "0" disables this behavior.
1686 </para> 1707 </para>
1687 </glossdef> 1708 </glossdef>
1688 </glossentry> 1709 </glossentry>