summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-10-22 10:30:58 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-10-23 15:20:19 +0100
commit38c853a83df6bfc721b563044a72f78466fa1f81 (patch)
tree7dda3e6297d151ee7c4171cb32ecaf1df89aba07 /documentation
parent01f2e75575c84c6922f00d7c2758b1d027ea7e4a (diff)
downloadpoky-38c853a83df6bfc721b563044a72f78466fa1f81.tar.gz
ref-manual: Applied review edits for new classes and variables.
These edits were minor with the addition of some descriptions that had to be fleshed out. All comments from Paul Eggleton. (From yocto-docs rev: 4ae7c5a5e5aa23307e28de0832d379145c4ef8f1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/ref-classes.xml19
-rw-r--r--documentation/ref-manual/ref-variables.xml99
2 files changed, 80 insertions, 38 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index 11961a7940..fed25b25e6 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -239,8 +239,8 @@
239 An alternative version of the 239 An alternative version of the
240 <link linkend='ref-classes-binconfig'><filename>binconfig</filename></link> 240 <link linkend='ref-classes-binconfig'><filename>binconfig</filename></link>
241 class, which disables binary configuration scripts by making them 241 class, which disables binary configuration scripts by making them
242 return an error in favor of installing them using 242 return an error in favor of using <filename>pkg-config</filename>
243 <filename>pkg-config</filename>. 243 to query the information.
244 The scripts to be disabled should be specified using the 244 The scripts to be disabled should be specified using the
245 <link linkend='var-BINCONFIG'><filename>BINCONFIG</filename></link> 245 <link linkend='var-BINCONFIG'><filename>BINCONFIG</filename></link>
246 variable within the recipe inheriting the class. 246 variable within the recipe inheriting the class.
@@ -465,7 +465,7 @@
465 <title><filename>compress_doc.bbclass</filename></title> 465 <title><filename>compress_doc.bbclass</filename></title>
466 466
467 <para> 467 <para>
468 Enables compression for man pages and information pages. 468 Enables compression for man pages and info pages.
469 This class is intended to be inherited globally. 469 This class is intended to be inherited globally.
470 The default compression mechanism is gz (gzip) but you can 470 The default compression mechanism is gz (gzip) but you can
471 select an alternative mechanism by setting the 471 select an alternative mechanism by setting the
@@ -492,10 +492,13 @@
492 <title><filename>copyleft_filter.bbclass</filename></title> 492 <title><filename>copyleft_filter.bbclass</filename></title>
493 493
494 <para> 494 <para>
495 A class used by the archiver and the 495 A class used by the
496 <link linkend='ref-classes-archiver'><filename>archiver</filename></link>
497 and
496 <link linkend='ref-classes-copyleft_compliance'><filename>copyleft_compliance</filename></link> 498 <link linkend='ref-classes-copyleft_compliance'><filename>copyleft_compliance</filename></link>
497 class for filtering licenses. 499 classes for filtering licenses.
498 This is an internal class and is not intended to be used directly. 500 The <filename>copyleft_filter</filename> class is an internal class
501 and is not intended to be used directly.
499 </para> 502 </para>
500</section> 503</section>
501 504
@@ -1059,7 +1062,7 @@
1059 1062
1060 <para> 1063 <para>
1061 You can also see the 1064 You can also see the
1062 <ulink url='https://wiki.archlinux.org/index.php/Gummiboot'>Gummiboot documentation</ulink> 1065 <ulink url='http://freedesktop.org/wiki/Software/gummiboot/'>Gummiboot documentation</ulink>
1063 for more information. 1066 for more information.
1064 </para> 1067 </para>
1065</section> 1068</section>
@@ -2620,7 +2623,7 @@
2620 <para> 2623 <para>
2621 Enables package tests (ptests) specifically for GNOME packages, 2624 Enables package tests (ptests) specifically for GNOME packages,
2622 which have tests intended to be executed with 2625 which have tests intended to be executed with
2623 gnome-desktop-testing. 2626 <filename>gnome-desktop-testing</filename>.
2624 </para> 2627 </para>
2625 2628
2626 <para> 2629 <para>
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index cc5382f334..09d01cb478 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -242,7 +242,19 @@
242 <glossentry id='var-ASSUME_PROVIDED'><glossterm>ASSUME_PROVIDED</glossterm> 242 <glossentry id='var-ASSUME_PROVIDED'><glossterm>ASSUME_PROVIDED</glossterm>
243 <glossdef> 243 <glossdef>
244 <para> 244 <para>
245 I need a description here. 245 Lists recipe names
246 (<link linkend='var-PN'><filename>PN</filename></link>
247 values) BitBake does not attempt to build.
248 Instead, BitBake assumes these recipes have already been
249 built.
250 </para>
251
252 <para>
253 In OpenEmbedded Core, <filename>ASSUME_PROVIDED</filename>
254 mostly specifies native tools that should not be built.
255 An example is <filename>git-native</filename>, which when
256 specified, allows for the Git binary from the host to be
257 used rather than building <filename>git-native</filename>.
246 </para> 258 </para>
247 </glossdef> 259 </glossdef>
248 </glossentry> 260 </glossentry>
@@ -898,11 +910,23 @@
898 <glossentry id='var-BINCONFIG'><glossterm>BINCONFIG</glossterm> 910 <glossentry id='var-BINCONFIG'><glossterm>BINCONFIG</glossterm>
899 <glossdef> 911 <glossdef>
900 <para> 912 <para>
901 Specifies binary configuration scripts to disable 913 When inheriting the
902 rather than installing them using 914 <link linkend='ref-classes-binconfig-disabled'><filename>binconfig-disabled</filename></link>
903 <filename>pkg-config</filename>. 915 class, this variable specifies binary configuration
904 The OpenEmbedded build system returns an error for the 916 scripts to disable in favor of using
905 disabled scripts. 917 <filename>pkg-config</filename> to query the information.
918 The <filename>binconfig-disabled</filename> class will
919 modify the specified scripts to return an error so that
920 calls to them can be easily found and replaced.
921 </para>
922
923 <para>
924 To add multiple scripts, separate them by spaces.
925 Here is an example from the <filename>libpng</filename>
926 recipe:
927 <literallayout class='monospaced'>
928 BINCONFIG = "${bindir}/libpng-config ${bindir}/libpng16-config"
929 </literallayout>
906 </para> 930 </para>
907 </glossdef> 931 </glossdef>
908 </glossentry> 932 </glossentry>
@@ -2216,14 +2240,17 @@
2216 <glossentry id='var-DOC_COMPRESS'><glossterm>DOC_COMPRESS</glossterm> 2240 <glossentry id='var-DOC_COMPRESS'><glossterm>DOC_COMPRESS</glossterm>
2217 <glossdef> 2241 <glossdef>
2218 <para> 2242 <para>
2219 Sets the compression policy used when the OpenEmbedded 2243 When inheriting <filename>compress_doc.bbclass</filename>
2220 build system compresses man pages and info pages. 2244 from a recipe, this variable sets the compression policy
2221 By default, the compression method used is gs (gzip). 2245 used when the OpenEmbedded build system compresses man
2246 pages and info pages.
2247 By default, the compression method used is gz (gzip).
2248 Other policies available are xz and bz2.
2222 </para> 2249 </para>
2223 2250
2224 <para> 2251 <para>
2225 For information on how to use this variable, see the 2252 For information on policies and on how to use this
2226 comments in the 2253 variable, see the comments in the
2227 <filename>compress_doc.bbclass</filename> file. 2254 <filename>compress_doc.bbclass</filename> file.
2228 </para> 2255 </para>
2229 </glossdef> 2256 </glossdef>
@@ -2235,10 +2262,15 @@
2235 2262
2236 <glossentry id='var-EFI_PROVIDER'><glossterm>EFI_PROVIDER</glossterm> 2263 <glossentry id='var-EFI_PROVIDER'><glossterm>EFI_PROVIDER</glossterm>
2237 <glossdef> 2264 <glossdef>
2238 <para></para>
2239 <para> 2265 <para>
2240 Setting this variable to "gummiboot" causes the 2266 When building bootable images (i.e. where
2241 OpenEmbedded build system to use the Gummiboot bootloader. 2267 <filename>hddimg</filename> or <filename>vmdk</filename>
2268 is in
2269 <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>),
2270 The <filename>EFI_PROVIDER</filename> variable specifies
2271 the EFI bootloader to use.
2272 The default is "grub-efi", but "gummiboot" can be used
2273 instead.
2242 </para> 2274 </para>
2243 2275
2244 <para> 2276 <para>
@@ -2246,11 +2278,6 @@
2246 <link linkend='ref-classes-gummiboot'><filename>gummiboot</filename></link> 2278 <link linkend='ref-classes-gummiboot'><filename>gummiboot</filename></link>
2247 class for more information. 2279 class for more information.
2248 </para> 2280 </para>
2249
2250 <para>
2251 For information on Gummiboot, see the
2252 <ulink url='https://wiki.archlinux.org/index.php/Gummiboot'>Gummiboot documentation</ulink>.
2253 </para>
2254 </glossdef> 2281 </glossdef>
2255 </glossentry> 2282 </glossentry>
2256 2283
@@ -3069,7 +3096,11 @@
3069 <glossentry id='var-GUMMIBOOT_CFG'><glossterm>GUMMIBOOT_CFG</glossterm> 3096 <glossentry id='var-GUMMIBOOT_CFG'><glossterm>GUMMIBOOT_CFG</glossterm>
3070 <glossdef> 3097 <glossdef>
3071 <para> 3098 <para>
3072 Specifies the configuration file that should be used. 3099 When
3100 <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link>
3101 is set to "gummiboot", the
3102 <filename>GUMMIBOOT_CFG</filename> variable specifies the
3103 configuration file that should be used.
3073 By default, the 3104 By default, the
3074 <link linkend='ref-classes-gummiboot'><filename>gummiboot</filename></link> 3105 <link linkend='ref-classes-gummiboot'><filename>gummiboot</filename></link>
3075 class sets the <filename>GUMMIBOOT_CFG</filename> as 3106 class sets the <filename>GUMMIBOOT_CFG</filename> as
@@ -3081,7 +3112,7 @@
3081 3112
3082 <para> 3113 <para>
3083 For information on Gummiboot, see the 3114 For information on Gummiboot, see the
3084 <ulink url='https://wiki.archlinux.org/index.php/Gummiboot'>Gummiboot documentation</ulink>. 3115 <ulink url='http://freedesktop.org/wiki/Software/gummiboot/'>Gummiboot documentation</ulink>.
3085 </para> 3116 </para>
3086 </glossdef> 3117 </glossdef>
3087 </glossentry> 3118 </glossentry>
@@ -3089,7 +3120,11 @@
3089 <glossentry id='var-GUMMIBOOT_ENTRIES'><glossterm>GUMMIBOOT_ENTRIES</glossterm> 3120 <glossentry id='var-GUMMIBOOT_ENTRIES'><glossterm>GUMMIBOOT_ENTRIES</glossterm>
3090 <glossdef> 3121 <glossdef>
3091 <para> 3122 <para>
3092 Specifies a list of entry files 3123 When
3124 <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link>
3125 is set to "gummiboot", the
3126 <filename>GUMMIBOOT_ENTRIES</filename> variable specifies
3127 a list of entry files
3093 (<filename>*.conf</filename>) to be installed 3128 (<filename>*.conf</filename>) to be installed
3094 containing one boot entry per file. 3129 containing one boot entry per file.
3095 By default, the 3130 By default, the
@@ -3103,7 +3138,7 @@
3103 3138
3104 <para> 3139 <para>
3105 For information on Gummiboot, see the 3140 For information on Gummiboot, see the
3106 <ulink url='https://wiki.archlinux.org/index.php/Gummiboot'>Gummiboot documentation</ulink>. 3141 <ulink url='http://freedesktop.org/wiki/Software/gummiboot/'>Gummiboot documentation</ulink>.
3107 </para> 3142 </para>
3108 </glossdef> 3143 </glossdef>
3109 </glossentry> 3144 </glossentry>
@@ -3111,7 +3146,11 @@
3111 <glossentry id='var-GUMMIBOOT_TIMEOUT'><glossterm>GUMMIBOOT_TIMEOUT</glossterm> 3146 <glossentry id='var-GUMMIBOOT_TIMEOUT'><glossterm>GUMMIBOOT_TIMEOUT</glossterm>
3112 <glossdef> 3147 <glossdef>
3113 <para> 3148 <para>
3114 Specifies the boot menu timeout in seconds. 3149 When
3150 <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link>
3151 is set to "gummiboot", the
3152 <filename>GUMMIBOOT_TIMEOUT</filename> variable specifies
3153 the boot menu timeout in seconds.
3115 By default, the 3154 By default, the
3116 <link linkend='ref-classes-gummiboot'><filename>gummiboot</filename></link> 3155 <link linkend='ref-classes-gummiboot'><filename>gummiboot</filename></link>
3117 class sets the <filename>GUMMIBOOT_TIMEOUT</filename> as 3156 class sets the <filename>GUMMIBOOT_TIMEOUT</filename> as
@@ -3123,7 +3162,7 @@
3123 3162
3124 <para> 3163 <para>
3125 For information on Gummiboot, see the 3164 For information on Gummiboot, see the
3126 <ulink url='https://wiki.archlinux.org/index.php/Gummiboot'>Gummiboot documentation</ulink>. 3165 <ulink url='http://freedesktop.org/wiki/Software/gummiboot/'>Gummiboot documentation</ulink>.
3127 </para> 3166 </para>
3128 </glossdef> 3167 </glossdef>
3129 </glossentry> 3168 </glossentry>
@@ -5197,7 +5236,6 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5197 5236
5198 <glossentry id='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'><glossterm>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</glossterm> 5237 <glossentry id='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'><glossterm>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</glossterm>
5199 <glossdef> 5238 <glossdef>
5200 <para></para>
5201 <para> 5239 <para>
5202 A list of required machine-specific packages to install as part of 5240 A list of required machine-specific packages to install as part of
5203 the image being built. 5241 the image being built.
@@ -5229,7 +5267,6 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5229 5267
5230 <glossentry id='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'><glossterm>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</glossterm> 5268 <glossentry id='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'><glossterm>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</glossterm>
5231 <glossdef> 5269 <glossdef>
5232 <para></para>
5233 <para> 5270 <para>
5234 A list of recommended machine-specific packages to install as part of 5271 A list of recommended machine-specific packages to install as part of
5235 the image being built. 5272 the image being built.
@@ -5316,7 +5353,6 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5316 5353
5317 <glossentry id='var-MACHINE_EXTRA_RRECOMMENDS'><glossterm>MACHINE_EXTRA_RRECOMMENDS</glossterm> 5354 <glossentry id='var-MACHINE_EXTRA_RRECOMMENDS'><glossterm>MACHINE_EXTRA_RRECOMMENDS</glossterm>
5318 <glossdef> 5355 <glossdef>
5319 <para></para>
5320 <para> 5356 <para>
5321 A list of machine-specific packages to install as part of the 5357 A list of machine-specific packages to install as part of the
5322 image being built that are not essential for booting the machine. 5358 image being built that are not essential for booting the machine.
@@ -7493,7 +7529,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7493 <glossentry id='var-SANITY_REQUIRED_UTILITIES'><glossterm>SANITY_REQUIRED_UTILITIES</glossterm> 7529 <glossentry id='var-SANITY_REQUIRED_UTILITIES'><glossterm>SANITY_REQUIRED_UTILITIES</glossterm>
7494 <glossdef> 7530 <glossdef>
7495 <para> 7531 <para>
7496 Need a description here. 7532 Specifies a list of command-line utilities that should be
7533 checked for during the initial sanity checking process when
7534 running BitBake.
7535 If any of the utilities are not installed on the build host,
7536 then BitBake immediately exits with an error.
7497 </para> 7537 </para>
7498 </glossdef> 7538 </glossdef>
7499 </glossentry> 7539 </glossentry>
@@ -8088,7 +8128,6 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
8088 8128
8089 <glossentry id='var-SRC_URI_OVERRIDES_PACKAGE_ARCH'><glossterm>SRC_URI_OVERRIDES_PACKAGE_ARCH</glossterm> 8129 <glossentry id='var-SRC_URI_OVERRIDES_PACKAGE_ARCH'><glossterm>SRC_URI_OVERRIDES_PACKAGE_ARCH</glossterm>
8090 <glossdef> 8130 <glossdef>
8091 <para></para>
8092 <para> 8131 <para>
8093 By default, the OpenEmbedded build system automatically detects whether 8132 By default, the OpenEmbedded build system automatically detects whether
8094 <filename><link linkend='var-SRC_URI'>SRC_URI</link></filename> 8133 <filename><link linkend='var-SRC_URI'>SRC_URI</link></filename>