sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

bitbake: bitbake-user-manual: Cleaned up parallelism note and formatted user input 

I updated the note in the second chapter that discusses the role for
BB_NUMBER_THREADS.  The updates make it a bit clearer.

Also scrubbed the manual for instances of user-supplied values to check
how they are being formatted.  I fixed the formatting to use the
<replaceable></replaceable> tags so they are in italics.

(Bitbake rev: e2879c60e905d7566091d40eab330372fa001313)

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 2015-04-16 13:15:29 -07:00 committed by Richard Purdie
parent 547b189951
commit 203aaaec08
5 changed files with 36 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.xml
View File

@ -21,7 +21,7 @@
The execution process is launched using the following command
form:
<literallayout class='monospaced'>
$ bitbake &lt;target&gt;
$ bitbake <replaceable>target</replaceable>
</literallayout>
For information on the BitBake command and its options,
see
@ -37,14 +37,16 @@
</para>
<para>
A common way to determine this value for your build host is to run:
A common method to determine this value for your build host is to run
the following:
<literallayout class='monospaced'>
$ grep processor /proc/cpuinfo
</literallayout>
and count the number of processors displayed. Note that the number of
processors will take into account hyper-threading, so that a quad-core
build host with hyper-threading will most likely show eight processors,
which is the value you would then assign to that variable.
This command returns the number of processors, which takes into
account hyper-threading.
Thus, a quad-core build host with hyper-threading most likely
shows eight processors, which is the value you would then assign to
<filename>BB_NUMBER_THREADS</filename>.
</para>
<para>
@ -782,13 +784,13 @@
make some dependency and hash information available to the build.
This information includes:
<itemizedlist>
<listitem><para><filename>BB_BASEHASH_task-&lt;taskname&gt;</filename>:
<listitem><para><filename>BB_BASEHASH_task-</filename><replaceable>taskname</replaceable>:
The base hashes for each task in the recipe.
</para></listitem>
<listitem><para><filename>BB_BASEHASH_&lt;filename:taskname&gt;</filename>:
<listitem><para><filename>BB_BASEHASH_</filename><replaceable>filename</replaceable><filename>:</filename><replaceable>taskname</replaceable>:
The base hashes for each dependent task.
</para></listitem>
<listitem><para><filename>BBHASHDEPS_&lt;filename:taskname&gt;</filename>:
<listitem><para><filename>BBHASHDEPS_</filename><replaceable>filename</replaceable><filename>:</filename><replaceable>taskname</replaceable>:
The task dependencies for each task.
</para></listitem>
<listitem><para><filename>BB_TASKHASH</filename>:

24
bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml
View File

@ -157,8 +157,8 @@
<filename>SRC_URI</filename> variable with the appropriate
varflags as follows:
<literallayout class='monospaced'>
SRC_URI[md5sum] = "value"
SRC_URI[sha256sum] = "value"
SRC_URI[md5sum] = "<replaceable>value</replaceable>"
SRC_URI[sha256sum] = "<replaceable>value</replaceable>"
</literallayout>
You can also specify the checksums as parameters on the
<filename>SRC_URI</filename> as shown below:
@ -646,13 +646,19 @@
</para></listitem>
<listitem><para><emphasis><filename>module</filename></emphasis>:
The module, which must include the
prepending "/" character, in the selected VOB
The <filename>module</filename> and <filename>vob</filename>
options are combined to create the following load rule in
the view config spec:
<literallayout class='monospaced'>
load &lt;vob&gt;&lt;module&gt;
</literallayout>
prepending "/" character, in the selected VOB.
<note>
The <filename>module</filename> and <filename>vob</filename>
options are combined to create the <filename>load</filename> rule in
the view config spec.
As an example, consider the <filename>vob</filename> and
<filename>module</filename> values from the
<filename>SRC_URI</filename> statement at the start of this section.
Combining those values results in the following:
<literallayout class='monospaced'>
load /example_vob/example_module
</literallayout>
</note>
</para></listitem>
<listitem><para><emphasis><filename>proto</filename></emphasis>:
The protocol, which can be either <filename>http</filename> or

2
bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.xml
View File

@ -221,7 +221,7 @@
<para>From your shell, enter the following commands to set and
export the <filename>BBPATH</filename> variable:
<literallayout class='monospaced'>
$ BBPATH="&lt;projectdirectory&gt;"
$ BBPATH="<replaceable>projectdirectory</replaceable>"
$ export BBPATH
</literallayout>
Use your actual project directory in the command.

6
bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
View File

@ -952,7 +952,7 @@
<listitem><para>
The class needs to define the function as follows:
<literallayout class='monospaced'>
&lt;classname&gt;_&lt;functionname&gt;
<replaceable>classname</replaceable><filename>_</filename><replaceable>functionname</replaceable>
</literallayout>
For example, if you have a class file
<filename>bar.bbclass</filename> and a function named
@ -966,7 +966,7 @@
The class needs to contain the <filename>EXPORT_FUNCTIONS</filename>
statement as follows:
<literallayout class='monospaced'>
EXPORT_FUNCTIONS &lt;functionname&gt;
EXPORT_FUNCTIONS <replaceable>functionname</replaceable>
</literallayout>
For example, continuing with the same example, the
statement in the <filename>bar.bbclass</filename> would be
@ -1164,7 +1164,7 @@
BitBake reads and writes varflags to the datastore using the following
command forms:
<literallayout class='monospaced'>
&lt;variable&gt; = d.getVarFlags("&lt;variable&gt;")
<replaceable>variable</replaceable> = d.getVarFlags("<replaceable>variable</replaceable>")
self.d.setVarFlags("FOO", {"func": True})
</literallayout>
</para>

12
bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml
View File

@ -872,7 +872,7 @@
that run on the target <filename>MACHINE</filename>;
"nativesdk", which targets the SDK machine instead of
<filename>MACHINE</filename>; and "mulitlibs" in the form
"<filename>multilib:&lt;multilib_name&gt;</filename>".
"<filename>multilib:</filename><replaceable>multilib_name</replaceable>".
</para>
<para>
@ -884,7 +884,7 @@
metadata:
<literallayout class='monospaced'>
BBCLASSEXTEND =+ "native nativesdk"
BBCLASSEXTEND =+ "multilib:&lt;multilib_name&gt;"
BBCLASSEXTEND =+ "multilib:<replaceable>multilib_name</replaceable>"
</literallayout>
</para>
</glossdef>
@ -1091,9 +1091,9 @@
Set the variable as you would any environment variable
and then run BitBake:
<literallayout class='monospaced'>
$ BBPATH="&lt;build_directory&gt;"
$ BBPATH="<replaceable>build_directory</replaceable>"
$ export BBPATH
$ bitbake &lt;target&gt;
$ bitbake <replaceable>target</replaceable>
</literallayout>
</para>
</glossdef>
@ -1888,7 +1888,7 @@
Here is the general syntax to specify versions with
the <filename>RDEPENDS</filename> variable:
<literallayout class='monospaced'>
RDEPENDS_${PN} = "&lt;package&gt; (&lt;operator&gt; &lt;version&gt;)"
RDEPENDS_${PN} = "<replaceable>package</replaceable> (<replaceable>operator</replaceable> <replaceable>version</replaceable>)"
</literallayout>
For <filename>operator</filename>, you can specify the
following:
@ -1954,7 +1954,7 @@
Here is the general syntax to specify versions with
the <filename>RRECOMMENDS</filename> variable:
<literallayout class='monospaced'>
RRECOMMENDS_${PN} = "&lt;package&gt; (&lt;operator&gt; &lt;version&gt;)"
RRECOMMENDS_${PN} = "<replaceable>package</replaceable> (<replaceable>operator</replaceable> <replaceable>version</replaceable>)"
</literallayout>
For <filename>operator</filename>, you can specify the
following: