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

bitbake: user-manual-bitbakecommand: Replace screen tags with literallayout 

(Bitbake rev: 4fffe48ab607fd0d2f884186006ee168874b8414)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Richard Purdie 2014-01-18 16:14:52 +00:00
parent 64f66d7821
commit 2375f55045
1 changed files with 68 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

107
bitbake/doc/user-manual/user-manual-bitbakecommand.xml
View File

@ -18,7 +18,8 @@
<section> <section>
<title>Usage and syntax</title> <title>Usage and syntax</title>
<para> <para>
<screen><prompt>$ </prompt>bitbake --help <literallayout class='monospaced'>
<prompt>$ </prompt>bitbake --help
Usage: bitbake [options] [recipename/target ...] Usage: bitbake [options] [recipename/target ...]
Executes the specified task (default is 'build') for a given set of target recipes (.bb files). Executes the specified task (default is 'build') for a given set of target recipes (.bb files).
@ -88,7 +89,8 @@ Options:
-m, --kill-server Terminate the remote server. -m, --kill-server Terminate the remote server.
--observe-only Connect to a server as an observing-only client. --observe-only Connect to a server as an observing-only client.
--status-only Check the status of the remote bitbake server. --status-only Check the status of the remote bitbake server.
</screen>
</literallayout>
</para> </para>
<para> <para>
@ -104,9 +106,15 @@ Options:
</para> </para>
<para><quote>clean</quote> task:</para> <para><quote>clean</quote> task:</para>
<para><screen><prompt>$ </prompt>bitbake -b blah_1.0.bb -c clean</screen></para> <literallayout class='monospaced'>
$ bitbake -b foo.bb -c clean
</literallayout>
<para><quote>build</quote> task:</para> <para><quote>build</quote> task:</para>
<para><screen><prompt>$ </prompt>bitbake -b blah_1.0.bb</screen></para> <literallayout class='monospaced'>
$ bitbake -b foo_1.0.bb
</literallayout>
</example> </example>
</para> </para>
<para> <para>
@ -137,13 +145,20 @@ Options:
anything else. anything else.
By default, a .bb generally PROVIDES its By default, a .bb generally PROVIDES its
packagename, packagename-version, and packagename-version-revision. packagename, packagename-version, and packagename-version-revision.
<literallayout class='monospaced'>
$ bitbake foo
$ bitbake foo-1.0
$ bitbake foo-1.0-r0
$ bitbake -c clean foo
$ bitbake virtual/whatever
$ bitbake -c clean virtual/whatever
</literallayout>
</para> </para>
<screen><prompt>$ </prompt>bitbake blah</screen>
<screen><prompt>$ </prompt>bitbake blah-1.0</screen>
<screen><prompt>$ </prompt>bitbake blah-1.0-r0</screen>
<screen><prompt>$ </prompt>bitbake -c clean blah</screen>
<screen><prompt>$ </prompt>bitbake virtual/whatever</screen>
<screen><prompt>$ </prompt>bitbake -c clean virtual/whatever</screen>
</example> </example>
<example> <example>
<title>Generating dependency graphs</title> <title>Generating dependency graphs</title>
@ -163,9 +178,12 @@ Options:
This way, <varname>DEPENDS</varname> from inherited classes This way, <varname>DEPENDS</varname> from inherited classes
such as base.bbclass can be removed from the such as base.bbclass can be removed from the
graph. graph.
<literallayout class='monospaced'>
$ bitbake -g foo
$ bitbake -g -I virtual/whatever -I bloom foo
</literallayout>
</para> </para>
<screen><prompt>$ </prompt>bitbake -g blah</screen>
<screen><prompt>$ </prompt>bitbake -g -I virtual/whatever -I bloom blah</screen>
</example> </example>
</para> </para>
</section> </section>
@ -198,7 +216,9 @@ Options:
<example> <example>
<title>Setting BBFILES</title> <title>Setting BBFILES</title>
<programlisting><varname>BBFILES</varname> = "/path/to/bbfiles/*.bb"</programlisting> <literallayout class='monospaced'>
BBFILES = "/path/to/bbfiles/*.bb"
</literallayout>
</example></para> </example></para>
<para> <para>
With regard to dependencies, it expects the With regard to dependencies, it expects the
@ -215,13 +235,16 @@ Options:
<title>Depending on another .bb</title> <title>Depending on another .bb</title>
<para> <para>
a.bb: <literallayout class='monospaced'>
<screen>PN = "package-a" a.bb:
DEPENDS += "package-b"</screen>
</para> PN = "package-a"
<para> DEPENDS += "package-b"
b.bb:
<screen>PN = "package-b"</screen> b.bb:
PN = "package-b"
</literallayout>
</para> </para>
</example> </example>
@ -230,20 +253,19 @@ b.bb:
<para> <para>
This example shows the usage of the <varname>PROVIDES</varname> variable, which allows a given .bb to specify what functionality it provides. This example shows the usage of the <varname>PROVIDES</varname> variable, which allows a given .bb to specify what functionality it provides.
</para> <literallayout class='monospaced'>
<para> package1.bb:
package1.bb:
<screen>PROVIDES += "virtual/package"</screen> PROVIDES += "virtual/package"
</para>
<para> package2.bb:
package2.bb:
<screen>DEPENDS += "virtual/package"</screen> DEPENDS += "virtual/package"
</para>
<para> package3.bb:
package3.bb:
<screen>PROVIDES += "virtual/package"</screen> PROVIDES += "virtual/package"
</para> </literallayout>
<para>
As you can see, we have two different As you can see, we have two different
.bb's that provide the same functionality .bb's that provide the same functionality
(virtual/package). (virtual/package).
@ -254,7 +276,9 @@ package3.bb:
</para> </para>
<para> <para>
The following would go into a .conf file, to select package1: The following would go into a .conf file, to select package1:
<screen>PREFERRED_PROVIDER_virtual/package = "package1"</screen> <literallayout class='monospaced'>
PREFERRED_PROVIDER_virtual/package = "package1"
</literallayout>
</para> </para>
</example> </example>
@ -289,7 +313,10 @@ The following would go into a .conf file, to select package1:
However, if we define the following variable in a However, if we define the following variable in a
.conf that BitBake parses, we .conf that BitBake parses, we
can change that. can change that.
<screen>PREFERRED_VERSION_a = "1.1"</screen> <literallayout class='monospaced'>
PREFERRED_VERSION_a = "1.1"
</literallayout>
</para> </para>
</example> </example>
<example> <example>
@ -305,13 +332,15 @@ The following would go into a .conf file, to select package1:
own local copy of an upstream repository, but with own local copy of an upstream repository, but with
custom modifications that one does not want upstream. custom modifications that one does not want upstream.
Usage: Usage:
</para> <literallayout class='monospaced'>
<screen> BBFILES = "/stuff/openembedded/*/*.bb /stuff/openembedded.modified/*/*.bb" BBFILES = "/stuff/openembedded/*/*.bb /stuff/openembedded.modified/*/*.bb"
BBFILE_COLLECTIONS = "upstream local" BBFILE_COLLECTIONS = "upstream local"
BBFILE_PATTERN_upstream = "^/stuff/openembedded/" BBFILE_PATTERN_upstream = "^/stuff/openembedded/"
BBFILE_PATTERN_local = "^/stuff/openembedded.modified/" BBFILE_PATTERN_local = "^/stuff/openembedded.modified/"
BBFILE_PRIORITY_upstream = "5" BBFILE_PRIORITY_upstream = "5"
BBFILE_PRIORITY_local = "10"</screen> BBFILE_PRIORITY_local = "10"
</literallayout>
</para>
</example> </example>
</section> </section>
</chapter> </chapter>