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>
This commit is contained in:
Scott Rifenbark
2014-10-16 16:31:19 -07:00
committed by Richard Purdie
parent b96378eb6b
commit 2eaf7e6e75
13 changed files with 166 additions and 160 deletions

View File

@@ -35,12 +35,12 @@
<link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>).
Here is an example:
<literallayout class='monospaced'>
$ source &OE_INIT_FILE; [&lt;build_dir&gt;]
$ source &OE_INIT_FILE; [<replaceable>build_dir</replaceable>]
</literallayout>
</para>
<para>
The <filename>build_dir</filename> argument is optional and specifies the directory the
The <replaceable>build_dir</replaceable> argument is optional and specifies the directory the
OpenEmbedded build system uses for the build -
the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
If you do not specify a Build Directory, it defaults to a directory
@@ -53,12 +53,12 @@
<para>
Once the build environment is set up, you can build a target using:
<literallayout class='monospaced'>
$ bitbake &lt;target&gt;
$ bitbake <replaceable>target</replaceable>
</literallayout>
</para>
<para>
The <filename>target</filename> is the name of the recipe you want to build.
The <replaceable>target</replaceable> is the name of the recipe you want to build.
Common targets are the images in <filename>meta/recipes-core/images</filename>,
<filename>meta/recipes-sato/images</filename>, etc. all found in the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
@@ -154,14 +154,14 @@
<title>Task Failures</title>
<para>The log file for shell tasks is available in
<filename>${WORKDIR}/temp/log.do_taskname.pid</filename>.
For example, the <filename>compile</filename> task for the QEMU minimal image for the x86
<filename>${WORKDIR}/temp/log.do_<replaceable>taskname</replaceable>.pid</filename>.
For example, the <filename>do_compile</filename> task for the QEMU minimal image for the x86
machine (<filename>qemux86</filename>) might be
<filename>tmp/work/qemux86-poky-linux/core-image-minimal/1.0-r0/temp/log.do_compile.20830</filename>.
To see what
<ulink url='&YOCTO_DOCS_DEV_URL;#bitbake-term'>BitBake</ulink>
runs to generate that log, look at the corresponding
<filename>run.do_taskname.pid</filename> file located in the same directory.
<filename>run.do_<replaceable>taskname</replaceable>.pid</filename> file located in the same directory.
</para>
<para>
@@ -203,7 +203,7 @@
$ bitbake matchbox-desktop
.
.
[make some changes to the source code in the work directory]
<replaceable>make some changes to the source code in the work directory</replaceable>
.
.
$ bitbake matchbox-desktop -c compile -f
@@ -238,7 +238,7 @@
<para>
Sometimes it can be hard to see why BitBake wants to build
other packages before building a given package you have specified.
The <filename>bitbake -g &lt;targetname&gt;</filename> command
The <filename>bitbake -g <replaceable>targetname</replaceable></filename> command
creates the <filename>pn-buildlist</filename>,
<filename>pn-depends.dot</filename>,
<filename>package-depends.dot</filename>, and
@@ -247,7 +247,7 @@
These files show what will be built and the package and task
dependencies, which are useful for debugging problems.
You can use the
<filename>bitbake -g -u depexp &lt;targetname&gt;</filename>
<filename>bitbake -g -u depexp <replaceable>targetname</replaceable></filename>
command to display the results in a more human-readable form.
</para>
</section>
@@ -264,7 +264,7 @@
</para>
<para>
The output from <filename>bitbake -DDD -v targetname</filename> can reveal why
The output from <filename>bitbake -DDD -v</filename> <replaceable>targetname</replaceable> can reveal why
BitBake chose a certain version of a package or why BitBake
picked a certain provider.
This command could also help you in a situation where you think BitBake did something
@@ -310,7 +310,7 @@
To build a specific recipe (<filename>.bb</filename> file),
you can use the following command form:
<literallayout class='monospaced'>
$ bitbake -b &lt;somepath/somerecipe.bb&gt;
$ bitbake -b <replaceable>somepath</replaceable>/<replaceable>somerecipe</replaceable>.bb
</literallayout>
This command form does not check for dependencies.
Consequently, you should use it
@@ -334,7 +334,7 @@
This next example shows the parsing environment for a specific
recipe:
<literallayout class='monospaced'>
$ bitbake -e &lt;recipename&gt;
$ bitbake -e <replaceable>recipename</replaceable>
</literallayout>
</para>
</section>