summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
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
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')
-rw-r--r--documentation/ref-manual/closer-look.xml32
-rw-r--r--documentation/ref-manual/faq.xml2
-rw-r--r--documentation/ref-manual/introduction.xml8
-rw-r--r--documentation/ref-manual/migration.xml25
-rw-r--r--documentation/ref-manual/ref-classes.xml24
-rw-r--r--documentation/ref-manual/ref-features.xml2
-rw-r--r--documentation/ref-manual/ref-images.xml46
-rw-r--r--documentation/ref-manual/ref-qa-checks.xml2
-rw-r--r--documentation/ref-manual/ref-structure.xml6
-rw-r--r--documentation/ref-manual/ref-tasks.xml10
-rw-r--r--documentation/ref-manual/ref-variables.xml132
-rw-r--r--documentation/ref-manual/technical-details.xml11
-rw-r--r--documentation/ref-manual/usingpoky.xml26
13 files changed, 166 insertions, 160 deletions
diff --git a/documentation/ref-manual/closer-look.xml b/documentation/ref-manual/closer-look.xml
index f0ed967228..c0c0d619a4 100644
--- a/documentation/ref-manual/closer-look.xml
+++ b/documentation/ref-manual/closer-look.xml
@@ -255,7 +255,7 @@
255 255
256 <para> 256 <para>
257 When you launch your build with the 257 When you launch your build with the
258 <filename>bitbake &lt;target&gt;</filename> command, BitBake 258 <filename>bitbake <replaceable>target</replaceable></filename> command, BitBake
259 sorts out the configurations to ultimately define your build 259 sorts out the configurations to ultimately define your build
260 environment. 260 environment.
261 </para> 261 </para>
@@ -351,7 +351,7 @@
351 Best practices dictate that you isolate these types of 351 Best practices dictate that you isolate these types of
352 configurations into their own layer. 352 configurations into their own layer.
353 Settings you provide in 353 Settings you provide in
354 <filename>conf/distro/&lt;distro&gt;.conf</filename> override 354 <filename>conf/distro/<replaceable>distro</replaceable>.conf</filename> override
355 similar 355 similar
356 settings that BitBake finds in your 356 settings that BitBake finds in your
357 <filename>conf/local.conf</filename> file in the Build 357 <filename>conf/local.conf</filename> file in the Build
@@ -375,7 +375,7 @@
375 This area holds configuration files for the 375 This area holds configuration files for the
376 layer (<filename>conf/layer.conf</filename>), 376 layer (<filename>conf/layer.conf</filename>),
377 the distribution 377 the distribution
378 (<filename>conf/distro/&lt;distro&gt;.conf</filename>), 378 (<filename>conf/distro/<replaceable>distro</replaceable>.conf</filename>),
379 and any distribution-wide include files. 379 and any distribution-wide include files.
380 </para></listitem> 380 </para></listitem>
381 <listitem><para><emphasis>recipes-*:</emphasis> 381 <listitem><para><emphasis>recipes-*:</emphasis>
@@ -408,7 +408,7 @@
408 <para> 408 <para>
409 The BSP Layer's configuration directory contains 409 The BSP Layer's configuration directory contains
410 configuration files for the machine 410 configuration files for the machine
411 (<filename>conf/machine/&lt;machine&gt;.conf</filename>) and, 411 (<filename>conf/machine/<replaceable>machine</replaceable>.conf</filename>) and,
412 of course, the layer (<filename>conf/layer.conf</filename>). 412 of course, the layer (<filename>conf/layer.conf</filename>).
413 </para> 413 </para>
414 414
@@ -1145,7 +1145,7 @@
1145 <para> 1145 <para>
1146 Images are written out to the 1146 Images are written out to the
1147 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> 1147 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
1148 inside the <filename>tmp/deploy/images/&lt;machine&gt;/</filename> 1148 inside the <filename>tmp/deploy/images/<replaceable>machine</replaceable>/</filename>
1149 folder as shown in the figure. 1149 folder as shown in the figure.
1150 This folder contains any files expected to be loaded on the 1150 This folder contains any files expected to be loaded on the
1151 target device. 1151 target device.
@@ -1157,43 +1157,43 @@
1157 variable points to the appropriate directory containing images for 1157 variable points to the appropriate directory containing images for
1158 the current configuration. 1158 the current configuration.
1159 <itemizedlist> 1159 <itemizedlist>
1160 <listitem><para><filename>&lt;kernel-image&gt;</filename>: 1160 <listitem><para><filename><replaceable>kernel-image</replaceable></filename>:
1161 A kernel binary file. 1161 A kernel binary file.
1162 The <link linkend='var-KERNEL_IMAGETYPE'><filename>KERNEL_IMAGETYPE</filename></link> 1162 The <link linkend='var-KERNEL_IMAGETYPE'><filename>KERNEL_IMAGETYPE</filename></link>
1163 variable setting determines the naming scheme for the 1163 variable setting determines the naming scheme for the
1164 kernel image file. 1164 kernel image file.
1165 Depending on that variable, the file could begin with 1165 Depending on that variable, the file could begin with
1166 a variety of naming strings. 1166 a variety of naming strings.
1167 The <filename>deploy/images/&lt;machine&gt;</filename> 1167 The <filename>deploy/images/<replaceable>machine</replaceable></filename>
1168 directory can contain multiple image files for the 1168 directory can contain multiple image files for the
1169 machine.</para></listitem> 1169 machine.</para></listitem>
1170 <listitem><para><filename>&lt;root-filesystem-image&gt;</filename>: 1170 <listitem><para><filename><replaceable>root-filesystem-image</replaceable></filename>:
1171 Root filesystems for the target device (e.g. 1171 Root filesystems for the target device (e.g.
1172 <filename>*.ext3</filename> or <filename>*.bz2</filename> 1172 <filename>*.ext3</filename> or <filename>*.bz2</filename>
1173 files). 1173 files).
1174 The <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> 1174 The <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>
1175 variable setting determines the root filesystem image 1175 variable setting determines the root filesystem image
1176 type. 1176 type.
1177 The <filename>deploy/images/&lt;machine&gt;</filename> 1177 The <filename>deploy/images/<replaceable>machine</replaceable></filename>
1178 directory can contain multiple root filesystems for the 1178 directory can contain multiple root filesystems for the
1179 machine.</para></listitem> 1179 machine.</para></listitem>
1180 <listitem><para><filename>&lt;kernel-modules&gt;</filename>: 1180 <listitem><para><filename><replaceable>kernel-modules</replaceable></filename>:
1181 Tarballs that contain all the modules built for the kernel. 1181 Tarballs that contain all the modules built for the kernel.
1182 Kernel module tarballs exist for legacy purposes and 1182 Kernel module tarballs exist for legacy purposes and
1183 can be suppressed by setting the 1183 can be suppressed by setting the
1184 <link linkend='var-MODULE_TARBALL_DEPLOY'><filename>MODULE_TARBALL_DEPLOY</filename></link> 1184 <link linkend='var-MODULE_TARBALL_DEPLOY'><filename>MODULE_TARBALL_DEPLOY</filename></link>
1185 variable to "0". 1185 variable to "0".
1186 The <filename>deploy/images/&lt;machine&gt;</filename> 1186 The <filename>deploy/images/<replaceable>machine</replaceable></filename>
1187 directory can contain multiple kernel module tarballs 1187 directory can contain multiple kernel module tarballs
1188 for the machine.</para></listitem> 1188 for the machine.</para></listitem>
1189 <listitem><para><filename>&lt;bootloaders&gt;</filename>: 1189 <listitem><para><filename><replaceable>bootloaders</replaceable></filename>:
1190 Bootloaders supporting the image, if applicable to the 1190 Bootloaders supporting the image, if applicable to the
1191 target machine. 1191 target machine.
1192 The <filename>deploy/images/&lt;machine&gt;</filename> 1192 The <filename>deploy/images/<replaceable>machine</replaceable></filename>
1193 directory can contain multiple bootloaders for the 1193 directory can contain multiple bootloaders for the
1194 machine.</para></listitem> 1194 machine.</para></listitem>
1195 <listitem><para><filename>&lt;symlinks&gt;</filename>: 1195 <listitem><para><filename><replaceable>symlinks</replaceable></filename>:
1196 The <filename>deploy/images/&lt;machine&gt;</filename> 1196 The <filename>deploy/images/<replaceable>machine</replaceable></filename>
1197 folder contains 1197 folder contains
1198 a symbolic link that points to the most recently built file 1198 a symbolic link that points to the most recently built file
1199 for each machine. 1199 for each machine.
@@ -1280,7 +1280,7 @@
1280 part of the SDK (i.e. the part that runs on 1280 part of the SDK (i.e. the part that runs on
1281 the <filename>SDKMACHINE</filename>). 1281 the <filename>SDKMACHINE</filename>).
1282 When you use 1282 When you use
1283 <filename>bitbake -c populate_sdk &lt;imagename&gt;</filename> 1283 <filename>bitbake -c populate_sdk <replaceable>imagename</replaceable></filename>
1284 to create the SDK, a set of default packages 1284 to create the SDK, a set of default packages
1285 apply. 1285 apply.
1286 This variable allows you to add more packages. 1286 This variable allows you to add more packages.
diff --git a/documentation/ref-manual/faq.xml b/documentation/ref-manual/faq.xml
index 5488f8ef23..da6ce20eef 100644
--- a/documentation/ref-manual/faq.xml
+++ b/documentation/ref-manual/faq.xml
@@ -321,7 +321,7 @@
321 <qandaentry> 321 <qandaentry>
322 <question> 322 <question>
323 <para> 323 <para>
324 What’s the difference between <filename>foo</filename> and <filename>foo-native</filename>? 324 What’s the difference between <replaceable>target</replaceable> and <replaceable>target</replaceable><filename>-native</filename>?
325 </para> 325 </para>
326 </question> 326 </question>
327 <answer> 327 <answer>
diff --git a/documentation/ref-manual/introduction.xml b/documentation/ref-manual/introduction.xml
index a81f4cbe09..f0db72a461 100644
--- a/documentation/ref-manual/introduction.xml
+++ b/documentation/ref-manual/introduction.xml
@@ -402,14 +402,14 @@
402 choose the installation directory. 402 choose the installation directory.
403 For example, you could choose the following: 403 For example, you could choose the following:
404 <literallayout class='monospaced'> 404 <literallayout class='monospaced'>
405 /home/your-username/buildtools 405 /home/<replaceable>your-username</replaceable>/buildtools
406 </literallayout> 406 </literallayout>
407 </para></listitem> 407 </para></listitem>
408 <listitem><para> 408 <listitem><para>
409 Source the tools environment setup script by using a 409 Source the tools environment setup script by using a
410 command like the following: 410 command like the following:
411 <literallayout class='monospaced'> 411 <literallayout class='monospaced'>
412 $ source /home/your-username/buildtools/environment-setup-i586-poky-linux 412 $ source /home/<replaceable>your-username</replaceable>/buildtools/environment-setup-i586-poky-linux
413 </literallayout> 413 </literallayout>
414 Of course, you need to supply your installation directory and be 414 Of course, you need to supply your installation directory and be
415 sure to use the right file (i.e. i585 or x86-64). 415 sure to use the right file (i.e. i585 or x86-64).
@@ -488,14 +488,14 @@
488 choose the installation directory. 488 choose the installation directory.
489 For example, you could choose the following: 489 For example, you could choose the following:
490 <literallayout class='monospaced'> 490 <literallayout class='monospaced'>
491 /home/your-username/buildtools 491 /home/<replaceable>your-username</replaceable>/buildtools
492 </literallayout> 492 </literallayout>
493 </para></listitem> 493 </para></listitem>
494 <listitem><para> 494 <listitem><para>
495 Source the tools environment setup script by using a 495 Source the tools environment setup script by using a
496 command like the following: 496 command like the following:
497 <literallayout class='monospaced'> 497 <literallayout class='monospaced'>
498 $ source /home/your-username/buildtools/environment-setup-i586-poky-linux 498 $ source /home/<replaceable>your-username</replaceable>/buildtools/environment-setup-i586-poky-linux
499 </literallayout> 499 </literallayout>
500 Of course, you need to supply your installation directory and be 500 Of course, you need to supply your installation directory and be
501 sure to use the right file (i.e. i585 or x86-64). 501 sure to use the right file (i.e. i585 or x86-64).
diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml
index f8bd852ad8..0e297b582a 100644
--- a/documentation/ref-manual/migration.xml
+++ b/documentation/ref-manual/migration.xml
@@ -110,7 +110,7 @@
110 appended to the path used to access the mirror. 110 appended to the path used to access the mirror.
111 Here is an example: 111 Here is an example:
112 <literallayout class='monospaced'> 112 <literallayout class='monospaced'>
113 SSTATE_MIRRORS = "file://.* http://someserver.tld/share/sstate/PATH" 113 SSTATE_MIRRORS = "file://.* http://<replaceable>someserver</replaceable>.tld/share/sstate/PATH"
114 </literallayout> 114 </literallayout>
115 </para> 115 </para>
116 </section> 116 </section>
@@ -375,10 +375,11 @@
375 <listitem><para><emphasis>Shared State Code:</emphasis> 375 <listitem><para><emphasis>Shared State Code:</emphasis>
376 The shared state code has been optimized to avoid running 376 The shared state code has been optimized to avoid running
377 unnecessary tasks. 377 unnecessary tasks.
378 For example, 378 For example, the following no longer populates the target
379 <filename>bitbake -c rootfs some-image</filename> from 379 sysroot since that is not necessary:
380 shared state no longer populates the target sysroot 380 <literallayout class='monospaced'>
381 since that is not necessary. 381 $ bitbake -c rootfs <replaceable>some-image</replaceable>
382 </literallayout>
382 Instead, the system just needs to extract the output 383 Instead, the system just needs to extract the output
383 package contents, re-create the packages, and construct 384 package contents, re-create the packages, and construct
384 the root filesystem. 385 the root filesystem.
@@ -832,7 +833,7 @@
832 This directory is located under 833 This directory is located under
833 <filename>sysroots</filename> and uses a machine-specific 834 <filename>sysroots</filename> and uses a machine-specific
834 name (i.e. 835 name (i.e.
835 <filename>tmp/sysroots/&lt;machine&gt;/pkgdata</filename>). 836 <filename>tmp/sysroots/<replaceable>machine</replaceable>/pkgdata</filename>).
836 </para></listitem> 837 </para></listitem>
837 </itemizedlist> 838 </itemizedlist>
838 </para> 839 </para>
@@ -1100,7 +1101,7 @@
1100 </para></listitem> 1101 </para></listitem>
1101 <listitem><para> 1102 <listitem><para>
1102 <filename>base-files</filename>: Remove the unnecessary 1103 <filename>base-files</filename>: Remove the unnecessary
1103 <filename>media/xxx</filename> directories. 1104 <filename>media/</filename><replaceable>xxx</replaceable> directories.
1104 </para></listitem> 1105 </para></listitem>
1105 <listitem><para> 1106 <listitem><para>
1106 <filename>alsa-state</filename>: Provide an empty 1107 <filename>alsa-state</filename>: Provide an empty
@@ -1228,7 +1229,7 @@
1228 value against the branch. 1229 value against the branch.
1229 You can specify the branch using the following form: 1230 You can specify the branch using the following form:
1230 <literallayout class='monospaced'> 1231 <literallayout class='monospaced'>
1231 SRC_URI = "git://server.name/repository;branch=&lt;branchname&gt;" 1232 SRC_URI = "git://server.name/repository;branch=<replaceable>branchname</replaceable>"
1232 </literallayout> 1233 </literallayout>
1233 If you do not specify a branch, BitBake looks 1234 If you do not specify a branch, BitBake looks
1234 in the default "master" branch. 1235 in the default "master" branch.
@@ -1305,10 +1306,10 @@
1305 </section> 1306 </section>
1306 1307
1307 <section id='migration-1.6-task-taskname-overrides'> 1308 <section id='migration-1.6-task-taskname-overrides'>
1308 <title><filename>task-&lt;taskname&gt;</filename> Overrides</title> 1309 <title><filename>task-</filename><replaceable>taskname</replaceable> Overrides</title>
1309 1310
1310 <para> 1311 <para>
1311 <filename>task-&lt;taskname&gt;</filename> overrides have been 1312 <filename>task-</filename><replaceable>taskname</replaceable> overrides have been
1312 adjusted so that tasks whose names contain underscores have the 1313 adjusted so that tasks whose names contain underscores have the
1313 underscores replaced by hyphens for the override so that they 1314 underscores replaced by hyphens for the override so that they
1314 now function properly. 1315 now function properly.
@@ -1932,8 +1933,8 @@
1932 </para></listitem> 1933 </para></listitem>
1933 <listitem><para> 1934 <listitem><para>
1934 Package QA checks are now performed during a new 1935 Package QA checks are now performed during a new
1935 <filename>do_package_qa</filename> task rather 1936 <link linkend='ref-tasks-package_qa'><filename>do_package_qa</filename></link>
1936 than being part of the 1937 task rather than being part of the
1937 <link linkend='ref-tasks-package'><filename>do_package</filename></link> 1938 <link linkend='ref-tasks-package'><filename>do_package</filename></link>
1938 task. 1939 task.
1939 This allows more parallel execution. 1940 This allows more parallel execution.
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index 0bc917c09c..ed6d059e01 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -1947,7 +1947,7 @@
1947 You can create a recipe that builds tools that run natively on the 1947 You can create a recipe that builds tools that run natively on the
1948 host a couple different ways: 1948 host a couple different ways:
1949 <itemizedlist> 1949 <itemizedlist>
1950 <listitem><para>Create a <filename>myrecipe-native.bb</filename> 1950 <listitem><para>Create a <replaceable>myrecipe</replaceable><filename>-native.bb</filename>
1951 that inherits the <filename>native</filename> class. 1951 that inherits the <filename>native</filename> class.
1952 If you use this method, you must order the inherit statement 1952 If you use this method, you must order the inherit statement
1953 in the recipe after all other inherit statements so that the 1953 in the recipe after all other inherit statements so that the
@@ -1988,7 +1988,7 @@
1988 You can create a recipe that builds tools that run on the SDK machine 1988 You can create a recipe that builds tools that run on the SDK machine
1989 a couple different ways: 1989 a couple different ways:
1990 <itemizedlist> 1990 <itemizedlist>
1991 <listitem><para>Create a <filename>myrecipe-nativesdk.bb</filename> 1991 <listitem><para>Create a <replaceable>myrecipe</replaceable><filename>-nativesdk.bb</filename>
1992 recipe that inherits the <filename>nativesdk</filename> class. 1992 recipe that inherits the <filename>nativesdk</filename> class.
1993 If you use this method, you must order the inherit statement 1993 If you use this method, you must order the inherit statement
1994 in the recipe after all other inherit statements so that the 1994 in the recipe after all other inherit statements so that the
@@ -2915,37 +2915,37 @@
2915 <para> 2915 <para>
2916 The class supports the following variables: 2916 The class supports the following variables:
2917 <itemizedlist> 2917 <itemizedlist>
2918 <listitem><para><emphasis><link linkend='var-INITRD'><filename>INITRD</filename></link>:</emphasis> 2918 <listitem><para><link linkend='var-INITRD'><filename>INITRD</filename></link>:
2919 Indicates list of filesystem images to concatenate and use as 2919 Indicates list of filesystem images to concatenate and use as
2920 an initial RAM disk (initrd). 2920 an initial RAM disk (initrd).
2921 This variable is optional.</para></listitem> 2921 This variable is optional.</para></listitem>
2922 <listitem><para><emphasis><link linkend='var-ROOTFS'><filename>ROOTFS</filename></link>:</emphasis> 2922 <listitem><para><link linkend='var-ROOTFS'><filename>ROOTFS</filename></link>:
2923 Indicates a filesystem image to include as the root filesystem. 2923 Indicates a filesystem image to include as the root filesystem.
2924 This variable is optional.</para></listitem> 2924 This variable is optional.</para></listitem>
2925 <listitem><para><emphasis><link linkend='var-AUTO_SYSLINUXMENU'><filename>AUTO_SYSLINUXMENU</filename></link>:</emphasis> 2925 <listitem><para><link linkend='var-AUTO_SYSLINUXMENU'><filename>AUTO_SYSLINUXMENU</filename></link>:
2926 Enables creating an automatic menu when set to "1". 2926 Enables creating an automatic menu when set to "1".
2927 </para></listitem> 2927 </para></listitem>
2928 <listitem><para><emphasis><link linkend='var-LABELS'><filename>LABELS</filename></link>:</emphasis> 2928 <listitem><para><link linkend='var-LABELS'><filename>LABELS</filename></link>:
2929 Lists targets for automatic configuration. 2929 Lists targets for automatic configuration.
2930 </para></listitem> 2930 </para></listitem>
2931 <listitem><para><emphasis><link linkend='var-APPEND'><filename>APPEND</filename></link>:</emphasis> 2931 <listitem><para><link linkend='var-APPEND'><filename>APPEND</filename></link>:
2932 Lists append string overrides for each label. 2932 Lists append string overrides for each label.
2933 </para></listitem> 2933 </para></listitem>
2934 <listitem><para><emphasis><link linkend='var-SYSLINUX_OPTS'><filename>SYSLINUX_OPTS</filename></link>:</emphasis> 2934 <listitem><para><link linkend='var-SYSLINUX_OPTS'><filename>SYSLINUX_OPTS</filename></link>:
2935 Lists additional options to add to the syslinux file. 2935 Lists additional options to add to the syslinux file.
2936 Semicolon characters separate multiple options. 2936 Semicolon characters separate multiple options.
2937 </para></listitem> 2937 </para></listitem>
2938 <listitem><para><emphasis><link linkend='var-SYSLINUX_SPLASH'><filename>SYSLINUX_SPLASH</filename></link>:</emphasis> 2938 <listitem><para><link linkend='var-SYSLINUX_SPLASH'><filename>SYSLINUX_SPLASH</filename></link>:
2939 Lists a background for the VGA boot menu when you are using the 2939 Lists a background for the VGA boot menu when you are using the
2940 boot menu.</para></listitem> 2940 boot menu.</para></listitem>
2941 <listitem><para><emphasis><link linkend='var-SYSLINUX_DEFAULT_CONSOLE'><filename>SYSLINUX_DEFAULT_CONSOLE</filename></link>:</emphasis> 2941 <listitem><para><link linkend='var-SYSLINUX_DEFAULT_CONSOLE'><filename>SYSLINUX_DEFAULT_CONSOLE</filename></link>:
2942 Set to "console=ttyX" to change kernel boot default console. 2942 Set to "console=ttyX" to change kernel boot default console.
2943 </para></listitem> 2943 </para></listitem>
2944 <listitem><para><emphasis><link linkend='var-SYSLINUX_SERIAL'><filename>SYSLINUX_SERIAL</filename></link>:</emphasis> 2944 <listitem><para><link linkend='var-SYSLINUX_SERIAL'><filename>SYSLINUX_SERIAL</filename></link>:
2945 Sets an alternate serial port. 2945 Sets an alternate serial port.
2946 Or, turns off serial when the variable is set with an 2946 Or, turns off serial when the variable is set with an
2947 empty string.</para></listitem> 2947 empty string.</para></listitem>
2948 <listitem><para><emphasis><link linkend='var-SYSLINUX_SERIAL_TTY'><filename>SYSLINUX_SERIAL_TTY</filename></link>:</emphasis> 2948 <listitem><para><link linkend='var-SYSLINUX_SERIAL_TTY'><filename>SYSLINUX_SERIAL_TTY</filename></link>:
2949 Sets an alternate "console=tty..." kernel boot argument. 2949 Sets an alternate "console=tty..." kernel boot argument.
2950 </para></listitem> 2950 </para></listitem>
2951 </itemizedlist> 2951 </itemizedlist>
diff --git a/documentation/ref-manual/ref-features.xml b/documentation/ref-manual/ref-features.xml
index b6f0bdc1e2..230cabd155 100644
--- a/documentation/ref-manual/ref-features.xml
+++ b/documentation/ref-manual/ref-features.xml
@@ -42,7 +42,7 @@
42 changed based on a given feature: 42 changed based on a given feature:
43 <literallayout class='monospaced'> 43 <literallayout class='monospaced'>
44 $ cd poky 44 $ cd poky
45 $ git grep 'contains.*MACHINE_FEATURES.*&lt;feature&gt;' 45 $ git grep 'contains.*MACHINE_FEATURES.*<replaceable>feature</replaceable>'
46 </literallayout> 46 </literallayout>
47 </para> 47 </para>
48 48
diff --git a/documentation/ref-manual/ref-images.xml b/documentation/ref-manual/ref-images.xml
index 503595c364..d15ca5b93a 100644
--- a/documentation/ref-manual/ref-images.xml
+++ b/documentation/ref-manual/ref-images.xml
@@ -38,9 +38,9 @@
38 </para> 38 </para>
39 39
40 <para> 40 <para>
41 Following, is a list of supported recipes: 41 Following is a list of supported recipes:
42 <itemizedlist> 42 <itemizedlist>
43 <listitem><para><emphasis><filename>build-appliance-image</filename>:</emphasis> 43 <listitem><para><filename>build-appliance-image</filename>:
44 An example virtual machine that contains all the pieces required to 44 An example virtual machine that contains all the pieces required to
45 run builds using the build system as well as the build system itself. 45 run builds using the build system as well as the build system itself.
46 You can boot and run the image using either the 46 You can boot and run the image using either the
@@ -49,18 +49,18 @@
49 For more information on this image, see the 49 For more information on this image, see the
50 <ulink url='&YOCTO_HOME_URL;/documentation/build-appliance'>Build Appliance</ulink> page on 50 <ulink url='&YOCTO_HOME_URL;/documentation/build-appliance'>Build Appliance</ulink> page on
51 the Yocto Project website.</para></listitem> 51 the Yocto Project website.</para></listitem>
52 <listitem><para><emphasis><filename>core-image-base</filename>:</emphasis> 52 <listitem><para><filename>core-image-base</filename>:
53 A console-only image that fully supports the target device hardware.</para></listitem> 53 A console-only image that fully supports the target device hardware.</para></listitem>
54 <listitem><para><emphasis><filename>core-image-clutter</filename>:</emphasis> 54 <listitem><para><filename>core-image-clutter</filename>:
55 An image with support for the Open GL-based toolkit Clutter, which enables development of 55 An image with support for the Open GL-based toolkit Clutter, which enables development of
56 rich and animated graphical user interfaces.</para></listitem> 56 rich and animated graphical user interfaces.</para></listitem>
57 <listitem><para><emphasis><filename>core-image-directfb</filename>:</emphasis> 57 <listitem><para><filename>core-image-directfb</filename>:
58 An image that uses <filename>directfb</filename> instead of X11. 58 An image that uses <filename>directfb</filename> instead of X11.
59 </para></listitem> 59 </para></listitem>
60 <listitem><para><emphasis><filename>core-image-full-cmdline</filename>:</emphasis> 60 <listitem><para><filename>core-image-full-cmdline</filename>:
61 A console-only image with more full-featured Linux system 61 A console-only image with more full-featured Linux system
62 functionality installed.</para></listitem> 62 functionality installed.</para></listitem>
63 <listitem><para><emphasis><filename>core-image-lsb</filename>:</emphasis> 63 <listitem><para><filename>core-image-lsb</filename>:
64 An image that conforms to the Linux Standard Base (LSB) 64 An image that conforms to the Linux Standard Base (LSB)
65 specification. 65 specification.
66 This image requires a distribution configuration that 66 This image requires a distribution configuration that
@@ -68,7 +68,7 @@
68 If you build <filename>core-image-lsb</filename> without that 68 If you build <filename>core-image-lsb</filename> without that
69 configuration, the image will not be LSB-compliant. 69 configuration, the image will not be LSB-compliant.
70 </para></listitem> 70 </para></listitem>
71 <listitem><para><emphasis><filename>core-image-lsb-dev</filename>:</emphasis> 71 <listitem><para><filename>core-image-lsb-dev</filename>:
72 A <filename>core-image-lsb</filename> image that is suitable for development work 72 A <filename>core-image-lsb</filename> image that is suitable for development work
73 using the host. 73 using the host.
74 The image includes headers and libraries you can use in a host development 74 The image includes headers and libraries you can use in a host development
@@ -78,7 +78,7 @@
78 If you build <filename>core-image-lsb-dev</filename> without that 78 If you build <filename>core-image-lsb-dev</filename> without that
79 configuration, the image will not be LSB-compliant. 79 configuration, the image will not be LSB-compliant.
80 </para></listitem> 80 </para></listitem>
81 <listitem><para><emphasis><filename>core-image-lsb-sdk</filename>:</emphasis> 81 <listitem><para><filename>core-image-lsb-sdk</filename>:
82 A <filename>core-image-lsb</filename> that includes everything in 82 A <filename>core-image-lsb</filename> that includes everything in
83 meta-toolchain but also includes development headers and libraries 83 meta-toolchain but also includes development headers and libraries
84 to form a complete standalone SDK. 84 to form a complete standalone SDK.
@@ -87,15 +87,15 @@
87 If you build <filename>core-image-lsb-sdk</filename> without that 87 If you build <filename>core-image-lsb-sdk</filename> without that
88 configuration, the image will not be LSB-compliant. 88 configuration, the image will not be LSB-compliant.
89 This image is suitable for development using the target.</para></listitem> 89 This image is suitable for development using the target.</para></listitem>
90 <listitem><para><emphasis><filename>core-image-minimal</filename>:</emphasis> 90 <listitem><para><filename>core-image-minimal</filename>:
91 A small image just capable of allowing a device to boot.</para></listitem> 91 A small image just capable of allowing a device to boot.</para></listitem>
92 <listitem><para><emphasis><filename>core-image-minimal-dev</filename>:</emphasis> 92 <listitem><para><filename>core-image-minimal-dev</filename>:
93 A <filename>core-image-minimal</filename> image suitable for development work 93 A <filename>core-image-minimal</filename> image suitable for development work
94 using the host. 94 using the host.
95 The image includes headers and libraries you can use in a host development 95 The image includes headers and libraries you can use in a host development
96 environment. 96 environment.
97 </para></listitem> 97 </para></listitem>
98 <listitem><para id='images-core-image-minimal-initramfs'><emphasis><filename>core-image-minimal-initramfs</filename>:</emphasis> 98 <listitem><para id='images-core-image-minimal-initramfs'><filename>core-image-minimal-initramfs</filename>:
99 A <filename>core-image-minimal</filename> image that has the Minimal RAM-based 99 A <filename>core-image-minimal</filename> image that has the Minimal RAM-based
100 Initial Root Filesystem (initramfs) as part of the kernel, 100 Initial Root Filesystem (initramfs) as part of the kernel,
101 which allows the system to find the first “init” program more efficiently. 101 which allows the system to find the first “init” program more efficiently.
@@ -104,38 +104,38 @@
104 variable for additional information helpful when working with 104 variable for additional information helpful when working with
105 initramfs images. 105 initramfs images.
106 </para></listitem> 106 </para></listitem>
107 <listitem><para><emphasis><filename>core-image-minimal-mtdutils</filename>:</emphasis> 107 <listitem><para><filename>core-image-minimal-mtdutils</filename>:
108 A <filename>core-image-minimal</filename> image that has support 108 A <filename>core-image-minimal</filename> image that has support
109 for the Minimal MTD Utilities, which let the user interact with the 109 for the Minimal MTD Utilities, which let the user interact with the
110 MTD subsystem in the kernel to perform operations on flash devices. 110 MTD subsystem in the kernel to perform operations on flash devices.
111 </para></listitem> 111 </para></listitem>
112 <listitem><para><emphasis><filename>core-image-rt</filename>:</emphasis> 112 <listitem><para><filename>core-image-rt</filename>:
113 A <filename>core-image-minimal</filename> image plus a real-time test suite and 113 A <filename>core-image-minimal</filename> image plus a real-time test suite and
114 tools appropriate for real-time use.</para></listitem> 114 tools appropriate for real-time use.</para></listitem>
115 <listitem><para><emphasis><filename>core-image-rt-sdk</filename>:</emphasis> 115 <listitem><para><filename>core-image-rt-sdk</filename>:
116 A <filename>core-image-rt</filename> image that includes everything in 116 A <filename>core-image-rt</filename> image that includes everything in
117 <filename>meta-toolchain</filename>. 117 <filename>meta-toolchain</filename>.
118 The image also includes development headers and libraries to form a complete 118 The image also includes development headers and libraries to form a complete
119 stand-alone SDK and is suitable for development using the target. 119 stand-alone SDK and is suitable for development using the target.
120 </para></listitem> 120 </para></listitem>
121 <listitem><para><emphasis><filename>core-image-sato</filename>:</emphasis> 121 <listitem><para><filename>core-image-sato</filename>:
122 An image with Sato support, a mobile environment and visual style that works well 122 An image with Sato support, a mobile environment and visual style that works well
123 with mobile devices. 123 with mobile devices.
124 The image supports X11 with a Sato theme and applications such as 124 The image supports X11 with a Sato theme and applications such as
125 a terminal, editor, file manager, media player, and so forth. 125 a terminal, editor, file manager, media player, and so forth.
126 </para></listitem> 126 </para></listitem>
127 <listitem><para><emphasis><filename>core-image-sato-dev</filename>:</emphasis> 127 <listitem><para><filename>core-image-sato-dev</filename>:
128 A <filename>core-image-sato</filename> image suitable for development 128 A <filename>core-image-sato</filename> image suitable for development
129 using the host. 129 using the host.
130 The image includes libraries needed to build applications on the device itself, 130 The image includes libraries needed to build applications on the device itself,
131 testing and profiling tools, and debug symbols. 131 testing and profiling tools, and debug symbols.
132 This image was formerly <filename>core-image-sdk</filename>. 132 This image was formerly <filename>core-image-sdk</filename>.
133 </para></listitem> 133 </para></listitem>
134 <listitem><para><emphasis><filename>core-image-sato-sdk</filename>:</emphasis> 134 <listitem><para><filename>core-image-sato-sdk</filename>:
135 A <filename>core-image-sato</filename> image that includes everything in meta-toolchain. 135 A <filename>core-image-sato</filename> image that includes everything in meta-toolchain.
136 The image also includes development headers and libraries to form a complete standalone SDK 136 The image also includes development headers and libraries to form a complete standalone SDK
137 and is suitable for development using the target.</para></listitem> 137 and is suitable for development using the target.</para></listitem>
138 <listitem><para><emphasis><filename>core-image-testmaster</filename>:</emphasis> 138 <listitem><para><filename>core-image-testmaster</filename>:
139 A "master" image designed to be used for automated runtime testing. 139 A "master" image designed to be used for automated runtime testing.
140 Provides a "known good" image that is deployed to a separate 140 Provides a "known good" image that is deployed to a separate
141 partition so that you can boot into it and use it to deploy a 141 partition so that you can boot into it and use it to deploy a
@@ -144,21 +144,21 @@
144 "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>" 144 "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>"
145 section in the Yocto Project Development Manual. 145 section in the Yocto Project Development Manual.
146 </para></listitem> 146 </para></listitem>
147 <listitem><para><emphasis><filename>core-image-testmaster-initramfs</filename>:</emphasis> 147 <listitem><para><filename>core-image-testmaster-initramfs</filename>:
148 A RAM-based Initial Root Filesystem (initramfs) image tailored for 148 A RAM-based Initial Root Filesystem (initramfs) image tailored for
149 use with the <filename>core-image-testmaster</filename> image. 149 use with the <filename>core-image-testmaster</filename> image.
150 </para></listitem> 150 </para></listitem>
151 <listitem><para><emphasis><filename>core-image-weston</filename>:</emphasis> 151 <listitem><para><filename>core-image-weston</filename>:
152 A very basic Wayland image with a terminal. 152 A very basic Wayland image with a terminal.
153 This image provides the Wayland protocol libraries and the 153 This image provides the Wayland protocol libraries and the
154 reference Weston compositor. 154 reference Weston compositor.
155 For more information, see the 155 For more information, see the
156 "<link linkend='wayland'>Wayland</link>" section. 156 "<link linkend='wayland'>Wayland</link>" section.
157 </para></listitem> 157 </para></listitem>
158 <listitem><para><emphasis><filename>core-image-x11</filename>:</emphasis> 158 <listitem><para><filename>core-image-x11</filename>:
159 A very basic X11 image with a terminal. 159 A very basic X11 image with a terminal.
160 </para></listitem> 160 </para></listitem>
161 <listitem><para><emphasis><filename>qt4e-demo-image</filename>:</emphasis> 161 <listitem><para><filename>qt4e-demo-image</filename>:
162 An image that launches into the demo application for the embedded 162 An image that launches into the demo application for the embedded
163 (not based on X11) version of Qt.</para></listitem> 163 (not based on X11) version of Qt.</para></listitem>
164 </itemizedlist> 164 </itemizedlist>
diff --git a/documentation/ref-manual/ref-qa-checks.xml b/documentation/ref-manual/ref-qa-checks.xml
index 969074bf60..871cd294f6 100644
--- a/documentation/ref-manual/ref-qa-checks.xml
+++ b/documentation/ref-manual/ref-qa-checks.xml
@@ -727,7 +727,7 @@ can be found then it should be implemented. I can't find one at the moment.
727 files that it should not have (e.g. a non-symlink 727 files that it should not have (e.g. a non-symlink
728 <filename>.so</filename> file) or it might have been added 728 <filename>.so</filename> file) or it might have been added
729 manually (e.g. by adding to 729 manually (e.g. by adding to
730 <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>. 730 <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>).
731 </para> 731 </para>
732 732
733 <para> 733 <para>
diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml
index eb1be38701..14419d3a84 100644
--- a/documentation/ref-manual/ref-structure.xml
+++ b/documentation/ref-manual/ref-structure.xml
@@ -315,7 +315,7 @@
315 commands. 315 commands.
316 Following is the script syntax: 316 Following is the script syntax:
317 <literallayout class='monospaced'> 317 <literallayout class='monospaced'>
318 $ source oe-init-build-env-memres &lt;port_number&gt; &lt;build_dir&gt; 318 $ source oe-init-build-env-memres <replaceable>port_number</replaceable> <replaceable>build_dir</replaceable>
319 </literallayout> 319 </literallayout>
320 The script uses other scripts within the 320 The script uses other scripts within the
321 <filename>scripts</filename> directory to do the bulk of the work. 321 <filename>scripts</filename> directory to do the bulk of the work.
@@ -499,7 +499,7 @@
499 the variable in the top-level build environment setup script as 499 the variable in the top-level build environment setup script as
500 follows: 500 follows:
501 <literallayout class='monospaced'> 501 <literallayout class='monospaced'>
502 TEMPLATECONF=&lt;your_layer&gt;/conf 502 TEMPLATECONF=<replaceable>your_layer</replaceable>/conf
503 </literallayout> 503 </literallayout>
504 Once the build process gets the sample file, it uses 504 Once the build process gets the sample file, it uses
505 <filename>sed</filename> to substitute final 505 <filename>sed</filename> to substitute final
@@ -554,7 +554,7 @@
554 you can base your build from any layer by setting the variable in 554 you can base your build from any layer by setting the variable in
555 the top-level build environment setup script as follows: 555 the top-level build environment setup script as follows:
556 <literallayout class='monospaced'> 556 <literallayout class='monospaced'>
557 TEMPLATECONF=&lt;your_layer&gt;/conf 557 TEMPLATECONF=<replaceable>your_layer</replaceable>/conf
558 </literallayout> 558 </literallayout>
559 Once the build process gets the sample file, it uses 559 Once the build process gets the sample file, it uses
560 <filename>sed</filename> to substitute final 560 <filename>sed</filename> to substitute final
diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml
index 1c8034b661..f325f0e233 100644
--- a/documentation/ref-manual/ref-tasks.xml
+++ b/documentation/ref-manual/ref-tasks.xml
@@ -324,7 +324,7 @@
324 <para> 324 <para>
325 You can run this task using BitBake as follows: 325 You can run this task using BitBake as follows:
326 <literallayout class='monospaced'> 326 <literallayout class='monospaced'>
327 $ bitbake -c clean &lt;recipe&gt; 327 $ bitbake -c clean <replaceable>recipe</replaceable>
328 </literallayout> 328 </literallayout>
329 </para> 329 </para>
330 330
@@ -338,7 +338,7 @@
338 If you want to remove the sstate cache files for the recipe, 338 If you want to remove the sstate cache files for the recipe,
339 you need to use the 339 you need to use the
340 <link linkend='ref-tasks-cleansstate'><filename>do_cleansstate</filename></link> 340 <link linkend='ref-tasks-cleansstate'><filename>do_cleansstate</filename></link>
341 task instead (i.e. <filename>bitbake -c cleansstate &lt;recipe&gt;</filename>). 341 task instead (i.e. <filename>bitbake -c cleansstate</filename> <replaceable>recipe</replaceable>).
342 </para> 342 </para>
343 </section> 343 </section>
344 344
@@ -359,7 +359,7 @@
359 <para> 359 <para>
360 You can run this task using BitBake as follows: 360 You can run this task using BitBake as follows:
361 <literallayout class='monospaced'> 361 <literallayout class='monospaced'>
362 $ bitbake -c cleanall &lt;recipe&gt; 362 $ bitbake -c cleanall <replaceable>recipe</replaceable>
363 </literallayout> 363 </literallayout>
364 </para> 364 </para>
365 365
@@ -389,7 +389,7 @@
389 <para> 389 <para>
390 You can run this task using BitBake as follows: 390 You can run this task using BitBake as follows:
391 <literallayout class='monospaced'> 391 <literallayout class='monospaced'>
392 $ bitbake -c cleansstate &lt;recipe&gt; 392 $ bitbake -c cleansstate <replaceable>recipe</replaceable>
393 </literallayout> 393 </literallayout>
394 </para> 394 </para>
395 395
@@ -404,7 +404,7 @@
404 If you need to build a target from scratch using remote 404 If you need to build a target from scratch using remote
405 mirrors, use the "-f" option as follows: 405 mirrors, use the "-f" option as follows:
406 <literallayout class='monospaced'> 406 <literallayout class='monospaced'>
407 $ bitbake -f -c do_cleansstate &lt;target&gt; 407 $ bitbake -f -c do_cleansstate <replaceable>target</replaceable>
408 </literallayout> 408 </literallayout>
409 </note> 409 </note>
410 </para> 410 </para>
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>
diff --git a/documentation/ref-manual/technical-details.xml b/documentation/ref-manual/technical-details.xml
index b0588351d5..6bb3381e72 100644
--- a/documentation/ref-manual/technical-details.xml
+++ b/documentation/ref-manual/technical-details.xml
@@ -85,7 +85,7 @@
85 </para> 85 </para>
86 86
87 <para> 87 <para>
88 The most common usage for BitBake is <filename>bitbake &lt;packagename&gt;</filename>, where 88 The most common usage for BitBake is <filename>bitbake <replaceable>packagename</replaceable></filename>, where
89 <filename>packagename</filename> is the name of the package you want to build 89 <filename>packagename</filename> is the name of the package you want to build
90 (referred to as the "target" in this manual). 90 (referred to as the "target" in this manual).
91 The target often equates to the first part of a recipe's filename 91 The target often equates to the first part of a recipe's filename
@@ -304,7 +304,8 @@
304 <para> 304 <para>
305 Here is the bootstrap process for the relocatable toolchain: 305 Here is the bootstrap process for the relocatable toolchain:
306 <literallayout class='monospaced'> 306 <literallayout class='monospaced'>
307 gcc -> binutils-crosssdk -> gcc-crosssdk-initial -> linux-libc-headers -> eglibc-initial -> nativesdk-eglibc -> gcc-crosssdk -> gcc-cross-canadian 307 gcc -> binutils-crosssdk -> gcc-crosssdk-initial -> linux-libc-headers ->
308 eglibc-initial -> nativesdk-eglibc -> gcc-crosssdk -> gcc-cross-canadian
308 </literallayout> 309 </literallayout>
309 <itemizedlist> 310 <itemizedlist>
310 <listitem><para><filename>gcc</filename>: 311 <listitem><para><filename>gcc</filename>:
@@ -608,13 +609,13 @@
608 make some dependency and hash information available to the build. 609 make some dependency and hash information available to the build.
609 This information includes: 610 This information includes:
610 <itemizedlist> 611 <itemizedlist>
611 <listitem><para><filename>BB_BASEHASH_task-&lt;taskname&gt;</filename>: 612 <listitem><para><filename>BB_BASEHASH_task-</filename><replaceable>taskname</replaceable>:
612 The base hashes for each task in the recipe. 613 The base hashes for each task in the recipe.
613 </para></listitem> 614 </para></listitem>
614 <listitem><para><filename>BB_BASEHASH_&lt;filename:taskname&gt;</filename>: 615 <listitem><para><filename>BB_BASEHASH_</filename><replaceable>filename</replaceable><filename>:</filename><replaceable>taskname</replaceable>:
615 The base hashes for each dependent task. 616 The base hashes for each dependent task.
616 </para></listitem> 617 </para></listitem>
617 <listitem><para><filename>BBHASHDEPS_&lt;filename:taskname&gt;</filename>: 618 <listitem><para><filename>BBHASHDEPS_</filename><replaceable>filename</replaceable><filename>:</filename><replaceable>taskname</replaceable>:
618 The task dependencies for each task. 619 The task dependencies for each task.
619 </para></listitem> 620 </para></listitem>
620 <listitem><para><filename>BB_TASKHASH</filename>: 621 <listitem><para><filename>BB_TASKHASH</filename>:
diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml
index 283fb725ac..1a211ca78a 100644
--- a/documentation/ref-manual/usingpoky.xml
+++ b/documentation/ref-manual/usingpoky.xml
@@ -35,12 +35,12 @@
35 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>). 35 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>).
36 Here is an example: 36 Here is an example:
37 <literallayout class='monospaced'> 37 <literallayout class='monospaced'>
38 $ source &OE_INIT_FILE; [&lt;build_dir&gt;] 38 $ source &OE_INIT_FILE; [<replaceable>build_dir</replaceable>]
39 </literallayout> 39 </literallayout>
40 </para> 40 </para>
41 41
42 <para> 42 <para>
43 The <filename>build_dir</filename> argument is optional and specifies the directory the 43 The <replaceable>build_dir</replaceable> argument is optional and specifies the directory the
44 OpenEmbedded build system uses for the build - 44 OpenEmbedded build system uses for the build -
45 the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. 45 the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
46 If you do not specify a Build Directory, it defaults to a directory 46 If you do not specify a Build Directory, it defaults to a directory
@@ -53,12 +53,12 @@
53 <para> 53 <para>
54 Once the build environment is set up, you can build a target using: 54 Once the build environment is set up, you can build a target using:
55 <literallayout class='monospaced'> 55 <literallayout class='monospaced'>
56 $ bitbake &lt;target&gt; 56 $ bitbake <replaceable>target</replaceable>
57 </literallayout> 57 </literallayout>
58 </para> 58 </para>
59 59
60 <para> 60 <para>
61 The <filename>target</filename> is the name of the recipe you want to build. 61 The <replaceable>target</replaceable> is the name of the recipe you want to build.
62 Common targets are the images in <filename>meta/recipes-core/images</filename>, 62 Common targets are the images in <filename>meta/recipes-core/images</filename>,
63 <filename>meta/recipes-sato/images</filename>, etc. all found in the 63 <filename>meta/recipes-sato/images</filename>, etc. all found in the
64 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. 64 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
@@ -154,14 +154,14 @@
154 <title>Task Failures</title> 154 <title>Task Failures</title>
155 155
156 <para>The log file for shell tasks is available in 156 <para>The log file for shell tasks is available in
157 <filename>${WORKDIR}/temp/log.do_taskname.pid</filename>. 157 <filename>${WORKDIR}/temp/log.do_<replaceable>taskname</replaceable>.pid</filename>.
158 For example, the <filename>compile</filename> task for the QEMU minimal image for the x86 158 For example, the <filename>do_compile</filename> task for the QEMU minimal image for the x86
159 machine (<filename>qemux86</filename>) might be 159 machine (<filename>qemux86</filename>) might be
160 <filename>tmp/work/qemux86-poky-linux/core-image-minimal/1.0-r0/temp/log.do_compile.20830</filename>. 160 <filename>tmp/work/qemux86-poky-linux/core-image-minimal/1.0-r0/temp/log.do_compile.20830</filename>.
161 To see what 161 To see what
162 <ulink url='&YOCTO_DOCS_DEV_URL;#bitbake-term'>BitBake</ulink> 162 <ulink url='&YOCTO_DOCS_DEV_URL;#bitbake-term'>BitBake</ulink>
163 runs to generate that log, look at the corresponding 163 runs to generate that log, look at the corresponding
164 <filename>run.do_taskname.pid</filename> file located in the same directory. 164 <filename>run.do_<replaceable>taskname</replaceable>.pid</filename> file located in the same directory.
165 </para> 165 </para>
166 166
167 <para> 167 <para>
@@ -203,7 +203,7 @@
203 $ bitbake matchbox-desktop 203 $ bitbake matchbox-desktop
204 . 204 .
205 . 205 .
206 [make some changes to the source code in the work directory] 206 <replaceable>make some changes to the source code in the work directory</replaceable>
207 . 207 .
208 . 208 .
209 $ bitbake matchbox-desktop -c compile -f 209 $ bitbake matchbox-desktop -c compile -f
@@ -238,7 +238,7 @@
238 <para> 238 <para>
239 Sometimes it can be hard to see why BitBake wants to build 239 Sometimes it can be hard to see why BitBake wants to build
240 other packages before building a given package you have specified. 240 other packages before building a given package you have specified.
241 The <filename>bitbake -g &lt;targetname&gt;</filename> command 241 The <filename>bitbake -g <replaceable>targetname</replaceable></filename> command
242 creates the <filename>pn-buildlist</filename>, 242 creates the <filename>pn-buildlist</filename>,
243 <filename>pn-depends.dot</filename>, 243 <filename>pn-depends.dot</filename>,
244 <filename>package-depends.dot</filename>, and 244 <filename>package-depends.dot</filename>, and
@@ -247,7 +247,7 @@
247 These files show what will be built and the package and task 247 These files show what will be built and the package and task
248 dependencies, which are useful for debugging problems. 248 dependencies, which are useful for debugging problems.
249 You can use the 249 You can use the
250 <filename>bitbake -g -u depexp &lt;targetname&gt;</filename> 250 <filename>bitbake -g -u depexp <replaceable>targetname</replaceable></filename>
251 command to display the results in a more human-readable form. 251 command to display the results in a more human-readable form.
252 </para> 252 </para>
253 </section> 253 </section>
@@ -264,7 +264,7 @@
264 </para> 264 </para>
265 265
266 <para> 266 <para>
267 The output from <filename>bitbake -DDD -v targetname</filename> can reveal why 267 The output from <filename>bitbake -DDD -v</filename> <replaceable>targetname</replaceable> can reveal why
268 BitBake chose a certain version of a package or why BitBake 268 BitBake chose a certain version of a package or why BitBake
269 picked a certain provider. 269 picked a certain provider.
270 This command could also help you in a situation where you think BitBake did something 270 This command could also help you in a situation where you think BitBake did something
@@ -310,7 +310,7 @@
310 To build a specific recipe (<filename>.bb</filename> file), 310 To build a specific recipe (<filename>.bb</filename> file),
311 you can use the following command form: 311 you can use the following command form:
312 <literallayout class='monospaced'> 312 <literallayout class='monospaced'>
313 $ bitbake -b &lt;somepath/somerecipe.bb&gt; 313 $ bitbake -b <replaceable>somepath</replaceable>/<replaceable>somerecipe</replaceable>.bb
314 </literallayout> 314 </literallayout>
315 This command form does not check for dependencies. 315 This command form does not check for dependencies.
316 Consequently, you should use it 316 Consequently, you should use it
@@ -334,7 +334,7 @@
334 This next example shows the parsing environment for a specific 334 This next example shows the parsing environment for a specific
335 recipe: 335 recipe:
336 <literallayout class='monospaced'> 336 <literallayout class='monospaced'>
337 $ bitbake -e &lt;recipename&gt; 337 $ bitbake -e <replaceable>recipename</replaceable>
338 </literallayout> 338 </literallayout>
339 </para> 339 </para>
340 </section> 340 </section>