summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-10-16 16:31:19 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-10-18 16:15:30 +0200
commit2eaf7e6e7524ec2a1eeca35b41f123fdee7e120b (patch)
treeace8abdef240fafd3bdbeed9001e67da40d7cbd8 /documentation/ref-manual/ref-variables.xml
parentb96378eb6b2443301b04dfc83eecf36eced6a27c (diff)
downloadpoky-2eaf7e6e7524ec2a1eeca35b41f123fdee7e120b.tar.gz
ref-manual: Scrubbed for variable (user) input.
Throughout the manual I had been using angled bracket sets to denote user-supplied input. This is confusing and better shown by using the <replaceable></replaceable> tags. I scrubbed all the chapters and replaced as needed. Some other minor formatting changes were caught and fixed during the scrub as well. (From yocto-docs rev: 9a668574dd18828a750cfa2e8c28e1f089a19609) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/ref-variables.xml')
-rw-r--r--documentation/ref-manual/ref-variables.xml132
1 files changed, 68 insertions, 64 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index aadae01ac4..1aabd5c71d 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -136,7 +136,7 @@
136 <note> 136 <note>
137 If <filename>ALTERNATIVE_LINK_NAME</filename> is not 137 If <filename>ALTERNATIVE_LINK_NAME</filename> is not
138 defined, it defaults to 138 defined, it defaults to
139 <filename>${bindir}/&lt;name&gt;</filename>. 139 <filename>${bindir}/<replaceable>name</replaceable></filename>.
140 </note> 140 </note>
141 </para> 141 </para>
142 142
@@ -159,9 +159,9 @@
159 a default for specific commands tied to particular packages. 159 a default for specific commands tied to particular packages.
160 Here are the available syntax forms: 160 Here are the available syntax forms:
161 <literallayout class='monospaced'> 161 <literallayout class='monospaced'>
162 ALTERNATIVE_PRIORITY = "&lt;priority&gt;" 162 ALTERNATIVE_PRIORITY = "<replaceable>priority</replaceable>"
163 ALTERNATIVE_PRIORITY[&lt;name&gt;] = "&lt;priority&gt;" 163 ALTERNATIVE_PRIORITY[<replaceable>name</replaceable>] = "<replaceable>priority</replaceable>"
164 ALTERNATIVE_PRIORITY_&lt;pkg&gt;[&lt;name&gt;] = "&lt;priority&gt;" 164 ALTERNATIVE_PRIORITY_<replaceable>pkg</replaceable>[<replaceable>name</replaceable>] = "<replaceable>priority</replaceable>"
165 </literallayout> 165 </literallayout>
166 </para> 166 </para>
167 167
@@ -185,9 +185,9 @@
185 a default for specific commands tied to particular packages. 185 a default for specific commands tied to particular packages.
186 Here are the available syntax forms: 186 Here are the available syntax forms:
187 <literallayout class='monospaced'> 187 <literallayout class='monospaced'>
188 ALTERNATIVE_TARGET = "&lt;target&gt;" 188 ALTERNATIVE_TARGET = "<replaceable>target</replaceable>"
189 ALTERNATIVE_TARGET[&lt;name&gt;] = "&lt;target&gt;" 189 ALTERNATIVE_TARGET[<replaceable>name</replaceable>] = "<replaceable>target</replaceable>"
190 ALTERNATIVE_TARGET_&lt;pkg&gt;[&lt;name&gt;] = "&lt;target&gt;" 190 ALTERNATIVE_TARGET_<replaceable>pkg</replaceable>[<replaceable>name</replaceable>] = "<replaceable>target</replaceable>"
191 </literallayout> 191 </literallayout>
192 <note> 192 <note>
193 <para> 193 <para>
@@ -338,13 +338,13 @@
338 being installed by listing them with the 338 being installed by listing them with the
339 <filename>BAD_RECOMMENDATIONS</filename> variable: 339 <filename>BAD_RECOMMENDATIONS</filename> variable:
340 <literallayout class='monospaced'> 340 <literallayout class='monospaced'>
341 BAD_RECOMMENDATIONS = "&lt;package_name&gt; &lt;package_name&gt; &lt;package_name&gt; ..." 341 BAD_RECOMMENDATIONS = "<replaceable>package_name</replaceable> <replaceable>package_name</replaceable> <replaceable>package_name</replaceable> ..."
342 </literallayout> 342 </literallayout>
343 You can set this variable globally in your 343 You can set this variable globally in your
344 <filename>local.conf</filename> file or you can attach it to 344 <filename>local.conf</filename> file or you can attach it to
345 a specific image recipe by using the recipe name override: 345 a specific image recipe by using the recipe name override:
346 <literallayout class='monospaced'> 346 <literallayout class='monospaced'>
347 BAD_RECOMMENDATIONS_pn-&lt;target_image&gt; = "&lt;package_name&gt;" 347 BAD_RECOMMENDATIONS_pn-<replaceable>target_image</replaceable> = "<replaceable>package_name</replaceable>"
348 </literallayout> 348 </literallayout>
349 </para> 349 </para>
350 350
@@ -445,11 +445,11 @@
445 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. 445 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
446 Use the following form: 446 Use the following form:
447 <literallayout class='monospaced'> 447 <literallayout class='monospaced'>
448 BB_DISKMON_DIRS = "&lt;action&gt;,&lt;dir&gt;,&lt;threshold&gt; [...]" 448 BB_DISKMON_DIRS = "<replaceable>action</replaceable>,<replaceable>dir</replaceable>,<replaceable>threshold</replaceable> [...]"
449 449
450 where: 450 where:
451 451
452 &lt;action&gt; is: 452 <replaceable>action</replaceable> is:
453 ABORT: Immediately abort the build when 453 ABORT: Immediately abort the build when
454 a threshold is broken. 454 a threshold is broken.
455 STOPTASKS: Stop the build after the currently 455 STOPTASKS: Stop the build after the currently
@@ -463,14 +463,14 @@
463 which must be defined in the 463 which must be defined in the
464 conf/local.conf file. 464 conf/local.conf file.
465 465
466 &lt;dir&gt; is: 466 <replaceable>dir</replaceable> is:
467 Any directory you choose. You can specify one or 467 Any directory you choose. You can specify one or
468 more directories to monitor by separating the 468 more directories to monitor by separating the
469 groupings with a space. If two directories are 469 groupings with a space. If two directories are
470 on the same device, only the first directory 470 on the same device, only the first directory
471 is monitored. 471 is monitored.
472 472
473 &lt;threshold&gt; is: 473 <replaceable>threshold</replaceable> is:
474 Either the minimum available disk space, 474 Either the minimum available disk space,
475 the minimum number of free inodes, or 475 the minimum number of free inodes, or
476 both. You must specify at least one. To 476 both. You must specify at least one. To
@@ -559,16 +559,16 @@
559 When specifying the variable in your configuration file, 559 When specifying the variable in your configuration file,
560 use the following form: 560 use the following form:
561 <literallayout class='monospaced'> 561 <literallayout class='monospaced'>
562 BB_DISKMON_WARNINTERVAL = "&lt;disk_space_interval&gt;,&lt;disk_inode_interval&gt;" 562 BB_DISKMON_WARNINTERVAL = "<replaceable>disk_space_interval</replaceable>,<replaceable>disk_inode_interval</replaceable>"
563 563
564 where: 564 where:
565 565
566 &lt;disk_space_interval&gt; is: 566 <replaceable>disk_space_interval</replaceable> is:
567 An interval of memory expressed in either 567 An interval of memory expressed in either
568 G, M, or K for Gbytes, Mbytes, or Kbytes, 568 G, M, or K for Gbytes, Mbytes, or Kbytes,
569 respectively. You cannot use GB, MB, or KB. 569 respectively. You cannot use GB, MB, or KB.
570 570
571 &lt;disk_inode_interval&gt; is: 571 <replaceable>disk_inode_interval</replaceable> is:
572 An interval of free inodes expressed in either 572 An interval of free inodes expressed in either
573 G, M, or K for Gbytes, Mbytes, or Kbytes, 573 G, M, or K for Gbytes, Mbytes, or Kbytes,
574 respectively. You cannot use GB, MB, or KB. 574 respectively. You cannot use GB, MB, or KB.
@@ -643,7 +643,7 @@
643 which is a compiler built to run on the build machine but produces binaries 643 which is a compiler built to run on the build machine but produces binaries
644 that run on the target <link linkend='var-MACHINE'><filename>MACHINE</filename></link>; 644 that run on the target <link linkend='var-MACHINE'><filename>MACHINE</filename></link>;
645 "nativesdk", which targets the SDK machine instead of <filename>MACHINE</filename>; 645 "nativesdk", which targets the SDK machine instead of <filename>MACHINE</filename>;
646 and "mulitlibs" in the form "<filename>multilib:&lt;multilib_name&gt;</filename>". 646 and "mulitlibs" in the form "<filename>multilib:</filename><replaceable>multilib_name</replaceable>".
647 </para> 647 </para>
648 648
649 <para> 649 <para>
@@ -651,7 +651,7 @@
651 is as simple as adding the following to your recipe: 651 is as simple as adding the following to your recipe:
652 <literallayout class='monospaced'> 652 <literallayout class='monospaced'>
653 BBCLASSEXTEND =+ "native nativesdk" 653 BBCLASSEXTEND =+ "native nativesdk"
654 BBCLASSEXTEND =+ "multilib:&lt;multilib_name&gt;" 654 BBCLASSEXTEND =+ "multilib:<replaceable>multilib_name</replaceable>"
655 </literallayout> 655 </literallayout>
656 </para> 656 </para>
657 </glossdef> 657 </glossdef>
@@ -856,9 +856,9 @@
856 Set the variable as you would any environment variable 856 Set the variable as you would any environment variable
857 and then run BitBake: 857 and then run BitBake:
858 <literallayout class='monospaced'> 858 <literallayout class='monospaced'>
859 $ BBPATH = "&lt;build_directory&gt;" 859 $ BBPATH = "<replaceable>build_directory</replaceable>"
860 $ export BBPATH 860 $ export BBPATH
861 $ bitbake &lt;target&gt; 861 $ bitbake <replaceable>target</replaceable>
862 </literallayout> 862 </literallayout>
863 </note> 863 </note>
864 </para> 864 </para>
@@ -2241,7 +2241,7 @@
2241 you want the error reporting tool to store the debug files 2241 you want the error reporting tool to store the debug files
2242 as follows in your <filename>local.conf</filename> file: 2242 as follows in your <filename>local.conf</filename> file:
2243 <literallayout class='monospaced'> 2243 <literallayout class='monospaced'>
2244 ERR_REPORT_DIR = "path" 2244 ERR_REPORT_DIR = "<replaceable>path</replaceable>"
2245 </literallayout> 2245 </literallayout>
2246 </para> 2246 </para>
2247 </glossdef> 2247 </glossdef>
@@ -2585,11 +2585,11 @@
2585 should have the name of the feature item as an override. 2585 should have the name of the feature item as an override.
2586 Here is an example: 2586 Here is an example:
2587 <literallayout class='monospaced'> 2587 <literallayout class='monospaced'>
2588 FEATURE_PACKAGES_widget = "package1 package2" 2588 FEATURE_PACKAGES_widget = "<replaceable>package1</replaceable> <replaceable>package2</replaceable>"
2589 </literallayout> 2589 </literallayout>
2590 In this example, if "widget" were added to 2590 In this example, if "widget" were added to
2591 <filename>IMAGE_FEATURES</filename>, "package1" and 2591 <filename>IMAGE_FEATURES</filename>, <replaceable>package1</replaceable> and
2592 "package2" would be included in the image. 2592 <replaceable>package2</replaceable> would be included in the image.
2593 <note> 2593 <note>
2594 Packages installed by features defined through 2594 Packages installed by features defined through
2595 <filename>FEATURE_PACKAGES</filename> are often package 2595 <filename>FEATURE_PACKAGES</filename> are often package
@@ -3468,7 +3468,7 @@
3468 <para> 3468 <para>
3469 When you use this variable, it is best to use it as follows: 3469 When you use this variable, it is best to use it as follows:
3470 <literallayout class='monospaced'> 3470 <literallayout class='monospaced'>
3471 IMAGE_INSTALL_append = " package-name" 3471 IMAGE_INSTALL_append = " <replaceable>package-name</replaceable>"
3472 </literallayout> 3472 </literallayout>
3473 Be sure to include the space between the quotation character 3473 Be sure to include the space between the quotation character
3474 and the start of the package name or names. 3474 and the start of the package name or names.
@@ -3520,7 +3520,7 @@
3520 The file contains package information on a line-per-package 3520 The file contains package information on a line-per-package
3521 basis as follows: 3521 basis as follows:
3522 <literallayout class='monospaced'> 3522 <literallayout class='monospaced'>
3523 &lt;packagename&gt; &lt;packagearch&gt; &lt;version&gt; 3523 <replaceable>packagename</replaceable> <replaceable>packagearch</replaceable> <replaceable>version</replaceable>
3524 </literallayout> 3524 </literallayout>
3525 </para> 3525 </para>
3526 3526
@@ -3653,7 +3653,7 @@
3653 OpenEmbedded build system has created the image. 3653 OpenEmbedded build system has created the image.
3654 You can specify shell commands separated by semicolons: 3654 You can specify shell commands separated by semicolons:
3655 <literallayout class='monospaced'> 3655 <literallayout class='monospaced'>
3656 IMAGE_POSTPROCESS_COMMAND += "&lt;shell_command&gt;; ... " 3656 IMAGE_POSTPROCESS_COMMAND += "<replaceable>shell_command</replaceable>; ... "
3657 </literallayout> 3657 </literallayout>
3658 If you need to pass the path to the root filesystem within 3658 If you need to pass the path to the root filesystem within
3659 the command, you can use 3659 the command, you can use
@@ -4458,7 +4458,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
4458 <para> 4458 <para>
4459 Specify it as follows: 4459 Specify it as follows:
4460 <literallayout class='monospaced'> 4460 <literallayout class='monospaced'>
4461 KERNEL_MODULE_AUTOLOAD += "modname1 modname2 modname3" 4461 KERNEL_MODULE_AUTOLOAD += "<replaceable>module_name1</replaceable> <replaceable>module_name2</replaceable> <replaceable>module_name3</replaceable>"
4462 </literallayout> 4462 </literallayout>
4463 </para> 4463 </para>
4464 4464
@@ -4470,7 +4470,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
4470 The modules appear one-per-line in the file. 4470 The modules appear one-per-line in the file.
4471 Here is an example of the most common use case: 4471 Here is an example of the most common use case:
4472 <literallayout class='monospaced'> 4472 <literallayout class='monospaced'>
4473 KERNEL_MODULE_AUTOLOAD += "modname" 4473 KERNEL_MODULE_AUTOLOAD += "<replaceable>module_name</replaceable>"
4474 </literallayout> 4474 </literallayout>
4475 </para> 4475 </para>
4476 4476
@@ -4489,7 +4489,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
4489 <para> 4489 <para>
4490 Provides a list of modules for which the OpenEmbedded 4490 Provides a list of modules for which the OpenEmbedded
4491 build system expects to find 4491 build system expects to find
4492 <link linkend='var-module_conf'><filename>module_conf_&lt;modname&gt;</filename></link> 4492 <filename>module_conf_</filename><replaceable>modname</replaceable>
4493 values that specify configuration for each of the modules. 4493 values that specify configuration for each of the modules.
4494 For information on how to provide those module 4494 For information on how to provide those module
4495 configurations, see the 4495 configurations, see the
@@ -4505,7 +4505,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
4505 The location of the kernel sources. 4505 The location of the kernel sources.
4506 This variable is set to the value of the 4506 This variable is set to the value of the
4507 <link linkend='var-STAGING_KERNEL_DIR'><filename>STAGING_KERNEL_DIR</filename></link> 4507 <link linkend='var-STAGING_KERNEL_DIR'><filename>STAGING_KERNEL_DIR</filename></link>
4508 within the <filename>module.bbclass</filename> class. 4508 within the
4509 <link linkend='ref-classes-module'><filename>module</filename></link>
4510 class.
4509 For information on how this variable is used, see the 4511 For information on how this variable is used, see the
4510 "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#incorporating-out-of-tree-modules'>Incorporating Out-of-Tree Modules</ulink>" 4512 "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#incorporating-out-of-tree-modules'>Incorporating Out-of-Tree Modules</ulink>"
4511 section. 4513 section.
@@ -4530,7 +4532,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
4530 The location of the kernel sources. 4532 The location of the kernel sources.
4531 This variable is set to the value of the 4533 This variable is set to the value of the
4532 <link linkend='var-STAGING_KERNEL_DIR'><filename>STAGING_KERNEL_DIR</filename></link> 4534 <link linkend='var-STAGING_KERNEL_DIR'><filename>STAGING_KERNEL_DIR</filename></link>
4533 within the <filename>module.bbclass</filename> class. 4535 within the
4536 <link linkend='ref-classes-module'><filename>module</filename></link>
4537 class.
4534 For information on how this variable is used, see the 4538 For information on how this variable is used, see the
4535 "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#incorporating-out-of-tree-modules'>Incorporating Out-of-Tree Modules</ulink>" 4539 "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#incorporating-out-of-tree-modules'>Incorporating Out-of-Tree Modules</ulink>"
4536 section. 4540 section.
@@ -4796,10 +4800,10 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
4796 <para> 4800 <para>
4797 This variable must be defined for all recipes (unless 4801 This variable must be defined for all recipes (unless
4798 <link linkend='var-LICENSE'><filename>LICENSE</filename></link> 4802 <link linkend='var-LICENSE'><filename>LICENSE</filename></link>
4799 is set to "CLOSED")</para> 4803 is set to "CLOSED").</para>
4800 <para>For more information, see the 4804 <para>For more information, see the
4801 <link linkend='usingpoky-configuring-LIC_FILES_CHKSUM'> 4805 "<link linkend='usingpoky-configuring-LIC_FILES_CHKSUM'>
4802 Tracking License Changes</link> section</para> 4806 Tracking License Changes</link>" section.</para>
4803 </glossdef> 4807 </glossdef>
4804 </glossentry> 4808 </glossentry>
4805 4809
@@ -4912,7 +4916,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
4912 The <filename>LICENSE_PATH</filename> variable allows you to extend that 4916 The <filename>LICENSE_PATH</filename> variable allows you to extend that
4913 location to other areas that have additional licenses: 4917 location to other areas that have additional licenses:
4914 <literallayout class='monospaced'> 4918 <literallayout class='monospaced'>
4915 LICENSE_PATH += "/path/to/additional/common/licenses" 4919 LICENSE_PATH += "<replaceable>path-to-additional-common-licenses</replaceable>"
4916 </literallayout></para> 4920 </literallayout></para>
4917 </glossdef> 4921 </glossdef>
4918 </glossentry> 4922 </glossentry>
@@ -5407,7 +5411,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5407 <para> 5411 <para>
5408 Here is the general syntax: 5412 Here is the general syntax:
5409 <literallayout class='monospaced'> 5413 <literallayout class='monospaced'>
5410 module_conf_&lt;modname&gt; = "&lt;modprobe.d syntax&gt;" 5414 module_conf_<replaceable>module_name</replaceable> = "<replaceable>modprobe.d-syntax</replaceable>"
5411 </literallayout> 5415 </literallayout>
5412 You must use the kernel module name override. 5416 You must use the kernel module name override.
5413 </para> 5417 </para>
@@ -5531,7 +5535,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5531 <filename>local.conf</filename> file or you can attach it to 5535 <filename>local.conf</filename> file or you can attach it to
5532 a specific image recipe by using the recipe name override: 5536 a specific image recipe by using the recipe name override:
5533 <literallayout class='monospaced'> 5537 <literallayout class='monospaced'>
5534 NO_RECOMMENDATIONS_pn-&lt;target_image&gt; = "&lt;package_name&gt;" 5538 NO_RECOMMENDATIONS_pn-<replaceable>target_image</replaceable> = "<replaceable>package_name</replaceable>"
5535 </literallayout> 5539 </literallayout>
5536 </para> 5540 </para>
5537 5541
@@ -5909,13 +5913,13 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5909 Lists packages that should not be installed into an image. 5913 Lists packages that should not be installed into an image.
5910 For example: 5914 For example:
5911 <literallayout class='monospaced'> 5915 <literallayout class='monospaced'>
5912 PACKAGE_EXCLUDE = "&lt;package_name&gt; &lt;package_name&gt; &lt;package_name&gt; ..." 5916 PACKAGE_EXCLUDE = "<replaceable>package_name</replaceable> <replaceable>package_name</replaceable> <replaceable>package_name</replaceable> ..."
5913 </literallayout> 5917 </literallayout>
5914 You can set this variable globally in your 5918 You can set this variable globally in your
5915 <filename>local.conf</filename> file or you can attach it to 5919 <filename>local.conf</filename> file or you can attach it to
5916 a specific image recipe by using the recipe name override: 5920 a specific image recipe by using the recipe name override:
5917 <literallayout class='monospaced'> 5921 <literallayout class='monospaced'>
5918 PACKAGE_EXCLUDE_pn-&lt;target_image&gt; = "&lt;package_name&gt;" 5922 PACKAGE_EXCLUDE_pn-<replaceable>target_image</replaceable> = "<replaceable>package_name</replaceable>"
5919 </literallayout> 5923 </literallayout>
5920 </para> 5924 </para>
5921 5925
@@ -6099,8 +6103,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
6099 <itemizedlist> 6103 <itemizedlist>
6100 <listitem><para><emphasis>Append file:</emphasis> 6104 <listitem><para><emphasis>Append file:</emphasis>
6101 Create an append file named 6105 Create an append file named
6102 <filename>&lt;recipename&gt;.bbappend</filename> in your 6106 <replaceable>recipename</replaceable><filename>.bbappend</filename>
6103 layer and override the value of 6107 in your layer and override the value of
6104 <filename>PACKAGECONFIG</filename>. 6108 <filename>PACKAGECONFIG</filename>.
6105 You can either completely override the variable: 6109 You can either completely override the variable:
6106 <literallayout class='monospaced'> 6110 <literallayout class='monospaced'>
@@ -6114,15 +6118,15 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
6114 This method is identical to changing the block 6118 This method is identical to changing the block
6115 through an append file except you edit your 6119 through an append file except you edit your
6116 <filename>local.conf</filename> or 6120 <filename>local.conf</filename> or
6117 <filename>&lt;mydistro&gt;.conf</filename> file. 6121 <filename><replaceable>mydistro</replaceable>.conf</filename> file.
6118 As with append files previously described, 6122 As with append files previously described,
6119 you can either completely override the variable: 6123 you can either completely override the variable:
6120 <literallayout class='monospaced'> 6124 <literallayout class='monospaced'>
6121 PACKAGECONFIG_pn-&lt;recipename&gt;="f4 f5" 6125 PACKAGECONFIG_pn-<replaceable>recipename</replaceable>="f4 f5"
6122 </literallayout> 6126 </literallayout>
6123 Or, you can just amend the variable: 6127 Or, you can just amend the variable:
6124 <literallayout class='monospaced'> 6128 <literallayout class='monospaced'>
6125 PACKAGECONFIG_append_pn-&lt;recipename&gt; = " f4" 6129 PACKAGECONFIG_append_pn-<replaceable>recipename</replaceable> = " f4"
6126 </literallayout></para></listitem> 6130 </literallayout></para></listitem>
6127 </itemizedlist> 6131 </itemizedlist>
6128 </para> 6132 </para>
@@ -6345,7 +6349,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
6345 For example, when the 6349 For example, when the
6346 <link linkend='ref-classes-debian'><filename>debian</filename></link> 6350 <link linkend='ref-classes-debian'><filename>debian</filename></link>
6347 class renames the output package, it does so by setting 6351 class renames the output package, it does so by setting
6348 <filename>PKG_&lt;packagename&gt;</filename>. 6352 <filename>PKG_<replaceable>packagename</replaceable></filename>.
6349 </para> 6353 </para>
6350 </glossdef> 6354 </glossdef>
6351 </glossentry> 6355 </glossentry>
@@ -6868,7 +6872,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
6868 them in conjunction with a package name override. 6872 them in conjunction with a package name override.
6869 Here is an example: 6873 Here is an example:
6870 <literallayout class='monospaced'> 6874 <literallayout class='monospaced'>
6871 RCONFLICTS_${PN} = "another-conflicting-package-name" 6875 RCONFLICTS_${PN} = "<replaceable>another-conflicting-package-name</replaceable>"
6872 </literallayout> 6876 </literallayout>
6873 </para> 6877 </para>
6874 6878
@@ -6880,7 +6884,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
6880 Here is the general syntax to specify versions with 6884 Here is the general syntax to specify versions with
6881 the <filename>RCONFLICTS</filename> variable: 6885 the <filename>RCONFLICTS</filename> variable:
6882 <literallayout class='monospaced'> 6886 <literallayout class='monospaced'>
6883 RCONFLICTS_${PN} = "&lt;package&gt; (&lt;operator&gt; &lt;version&gt;)" 6887 RCONFLICTS_${PN} = "<replaceable>package</replaceable> (<replaceable>operator</replaceable> <replaceable>version</replaceable>)"
6884 </literallayout> 6888 </literallayout>
6885 For <filename>operator</filename>, you can specify the 6889 For <filename>operator</filename>, you can specify the
6886 following: 6890 following:
@@ -6972,7 +6976,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
6972 as it would in the <filename>PACKAGES</filename> 6976 as it would in the <filename>PACKAGES</filename>
6973 namespace before any renaming of the output package by 6977 namespace before any renaming of the output package by
6974 classes like 6978 classes like
6975 <link linkend='ref-classes-debian'><filename>debian.bbclass</filename></link>. 6979 <link linkend='ref-classes-debian'><filename>debian</filename></link>.
6976 </para> 6980 </para>
6977 6981
6978 <para> 6982 <para>
@@ -7006,7 +7010,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7006 Here is the general syntax to specify versions with 7010 Here is the general syntax to specify versions with
7007 the <filename>RDEPENDS</filename> variable: 7011 the <filename>RDEPENDS</filename> variable:
7008 <literallayout class='monospaced'> 7012 <literallayout class='monospaced'>
7009 RDEPENDS_${PN} = "&lt;package&gt; (&lt;operator&gt; &lt;version&gt;)" 7013 RDEPENDS_${PN} = "<replaceable>package</replaceable> (<replaceable>operator</replaceable> <replaceable>version</replaceable>)"
7010 </literallayout> 7014 </literallayout>
7011 For <filename>operator</filename>, you can specify the 7015 For <filename>operator</filename>, you can specify the
7012 following: 7016 following:
@@ -7136,7 +7140,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7136 OpenEmbedded build system has created the root filesystem. 7140 OpenEmbedded build system has created the root filesystem.
7137 You can specify shell commands separated by semicolons: 7141 You can specify shell commands separated by semicolons:
7138 <literallayout class='monospaced'> 7142 <literallayout class='monospaced'>
7139 ROOTFS_POSTPROCESS_COMMAND += "&lt;shell_command&gt;; ... " 7143 ROOTFS_POSTPROCESS_COMMAND += "<replaceable>shell_command</replaceable>; ... "
7140 </literallayout> 7144 </literallayout>
7141 If you need to pass the path to the root filesystem within 7145 If you need to pass the path to the root filesystem within
7142 the command, you can use 7146 the command, you can use
@@ -7224,7 +7228,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7224 that is extended to support wireless functionality. 7228 that is extended to support wireless functionality.
7225 In this case, you would use the following: 7229 In this case, you would use the following:
7226 <literallayout class='monospaced'> 7230 <literallayout class='monospaced'>
7227 RRECOMMENDS_${PN}-dev += "&lt;wireless_package_name&gt;" 7231 RRECOMMENDS_${PN}-dev += "<replaceable>wireless_package_name</replaceable>"
7228 </literallayout> 7232 </literallayout>
7229 In the example, the package name 7233 In the example, the package name
7230 (<filename>${<link linkend='var-PN'>PN</link>}-dev</filename>) 7234 (<filename>${<link linkend='var-PN'>PN</link>}-dev</filename>)
@@ -7242,7 +7246,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7242 Here is the general syntax to specify versions with 7246 Here is the general syntax to specify versions with
7243 the <filename>RRECOMMENDS</filename> variable: 7247 the <filename>RRECOMMENDS</filename> variable:
7244 <literallayout class='monospaced'> 7248 <literallayout class='monospaced'>
7245 RRECOMMENDS_${PN} = "&lt;package&gt; (&lt;operator&gt; &lt;version&gt;)" 7249 RRECOMMENDS_${PN} = "<replaceable>package</replaceable> (<replaceable>operator</replaceable> <replaceable>version</replaceable>)"
7246 </literallayout> 7250 </literallayout>
7247 For <filename>operator</filename>, you can specify the 7251 For <filename>operator</filename>, you can specify the
7248 following: 7252 following:
@@ -7280,7 +7284,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7280 override. 7284 override.
7281 Here is an example: 7285 Here is an example:
7282 <literallayout class='monospaced'> 7286 <literallayout class='monospaced'>
7283 RREPLACES_${PN} = "other-package-being-replaced" 7287 RREPLACES_${PN} = "<replaceable>other-package-being-replaced</replaceable>"
7284 </literallayout> 7288 </literallayout>
7285 </para> 7289 </para>
7286 7290
@@ -7292,7 +7296,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7292 Here is the general syntax to specify versions with 7296 Here is the general syntax to specify versions with
7293 the <filename>RREPLACES</filename> variable: 7297 the <filename>RREPLACES</filename> variable:
7294 <literallayout class='monospaced'> 7298 <literallayout class='monospaced'>
7295 RREPLACES_${PN} = "&lt;package&gt; (&lt;operator&gt; &lt;version&gt;)" 7299 RREPLACES_${PN} = "<replaceable>package</replaceable> (<replaceable>operator</replaceable> <replaceable>version</replaceable>)"
7296 </literallayout> 7300 </literallayout>
7297 For <filename>operator</filename>, you can specify the 7301 For <filename>operator</filename>, you can specify the
7298 following: 7302 following:
@@ -7327,7 +7331,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7327 override. 7331 override.
7328 Here is an example: 7332 Here is an example:
7329 <literallayout class='monospaced'> 7333 <literallayout class='monospaced'>
7330 RSUGGESTS_${PN} = "useful-package another-package" 7334 RSUGGESTS_${PN} = "<replaceable>useful-package</replaceable> <replaceable>another-package</replaceable>"
7331 </literallayout> 7335 </literallayout>
7332 </para> 7336 </para>
7333 </glossdef> 7337 </glossdef>
@@ -7503,7 +7507,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7503 However, this variable applies to the SDK generated from an 7507 However, this variable applies to the SDK generated from an
7504 image using the following command: 7508 image using the following command:
7505 <literallayout class='monospaced'> 7509 <literallayout class='monospaced'>
7506 $ bitbake -c populate_sdk imagename 7510 $ bitbake -c populate_sdk <replaceable>imagename</replaceable>
7507 </literallayout> 7511 </literallayout>
7508 </para> 7512 </para>
7509 </glossdef> 7513 </glossdef>
@@ -8083,8 +8087,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
8083 directory structure. 8087 directory structure.
8084 <literallayout class='monospaced'> 8088 <literallayout class='monospaced'>
8085 SSTATE_MIRRORS ?= "\ 8089 SSTATE_MIRRORS ?= "\
8086 file://.* http://someserver.tld/share/sstate/PATH \n \ 8090 file://.* http://<replaceable>someserver</replaceable>.tld/share/sstate/PATH \n \
8087 file://.* file:///some/local/dir/sstate/PATH" 8091 file://.* file:///<replaceable>some-local-dir</replaceable>/sstate/PATH"
8088 </literallayout> 8092 </literallayout>
8089 </para> 8093 </para>
8090 </glossdef> 8094 </glossdef>
@@ -9090,7 +9094,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
9090 You can add your own tests to the list of tests by 9094 You can add your own tests to the list of tests by
9091 appending <filename>TEST_SUITES</filename> as follows: 9095 appending <filename>TEST_SUITES</filename> as follows:
9092 <literallayout class='monospaced'> 9096 <literallayout class='monospaced'>
9093 TEST_SUITES_append = " mytest" 9097 TEST_SUITES_append = " <replaceable>mytest</replaceable>"
9094 </literallayout> 9098 </literallayout>
9095 Alternatively, you can provide the "auto" option to 9099 Alternatively, you can provide the "auto" option to
9096 have all applicable tests run against the image. 9100 have all applicable tests run against the image.
@@ -9511,11 +9515,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
9511 </glossdef> 9515 </glossdef>
9512 </glossentry> 9516 </glossentry>
9513 9517
9514 <glossentry id='var-TUNECONFLICT'><glossterm>TUNECONFLICT[&lt;feature&gt;]</glossterm> 9518 <glossentry id='var-TUNECONFLICT'><glossterm>TUNECONFLICT[<replaceable>feature</replaceable>]</glossterm>
9515 <glossdef> 9519 <glossdef>
9516 <para> 9520 <para>
9517 Specifies CPU or Application Binary Interface (ABI) 9521 Specifies CPU or Application Binary Interface (ABI)
9518 tuning features that conflict with &gt;feature&lt;. 9522 tuning features that conflict with <replaceable>feature</replaceable>.
9519 </para> 9523 </para>
9520 9524
9521 <para> 9525 <para>
@@ -9533,7 +9537,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
9533 </glossdef> 9537 </glossdef>
9534 </glossentry> 9538 </glossentry>
9535 9539
9536 <glossentry id='var-TUNEVALID'><glossterm>TUNEVALID[&lt;feature&gt;]</glossterm> 9540 <glossentry id='var-TUNEVALID'><glossterm>TUNEVALID[<replaceable>feature</replaceable>]</glossterm>
9537 <glossdef> 9541 <glossdef>
9538 <para> 9542 <para>
9539 Specifies a valid CPU or Application Binary Interface (ABI) 9543 Specifies a valid CPU or Application Binary Interface (ABI)
@@ -9644,7 +9648,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
9644 The value indicates the target platform configuration. 9648 The value indicates the target platform configuration.
9645 You typically set this variable from the machine 9649 You typically set this variable from the machine
9646 configuration file (i.e. 9650 configuration file (i.e.
9647 <filename>conf/machine/&lt;machine_name&gt;.conf</filename>). 9651 <filename>conf/machine/<replaceable>machine_name</replaceable>.conf</filename>).
9648 </para> 9652 </para>
9649 9653
9650 <para> 9654 <para>