summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/closer-look.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/closer-look.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/closer-look.xml')
-rw-r--r--documentation/ref-manual/closer-look.xml32
1 files changed, 16 insertions, 16 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.