summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-09-17 14:02:18 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-09-17 22:27:50 +0100
commit6983afab0ce8d82d102142636d5a570f7d86a844 (patch)
treebdabe7a85b47b5521595d4a326bdf00885e174a1
parent4aff249ff51aa9fab05d3b65a78016e779af775c (diff)
downloadbitbake-6983afab0ce8d82d102142636d5a570f7d86a844.tar.gz
usermanual.xml: Two new sections added to BitBake "Description"
1. Added a new section "Appending and Prepending (override style syntax)". This section shows how the append and prepend operators work using the override style syntax. 2. Added a new section "Removing (override style syntax)". This section describes the new "_remove" operator. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--doc/manual/usermanual.xml20
1 files changed, 19 insertions, 1 deletions
diff --git a/doc/manual/usermanual.xml b/doc/manual/usermanual.xml
index e776b43c4..6781a71a6 100644
--- a/doc/manual/usermanual.xml
+++ b/doc/manual/usermanual.xml
@@ -138,6 +138,24 @@ share common metadata between many packages.</para></listitem>
will be introduced.</para>
</section>
<section>
+ <title>Appending and Prepending (override style syntax)</title>
+ <para><screen><varname>B</varname> = "bval"
+<varname>B_append</varname> = " additional data"
+<varname>C</varname> = "cval"
+<varname>C_prepend</varname> = "additional data "</screen></para>
+ <para>This example results in <varname>B</varname> becoming <literal>bval additional data</literal>
+and <varname>C</varname> becoming <literal>additional data cval</literal>. Note the spaces in the append.
+Unlike the += operator, additional space is not automatically added. You must take steps to add space
+yourself.</para>
+ </section>
+ <section>
+ <title>Removing (override style syntax)</title>
+ <para><screen><varname>FOO</varname> = "123 456 789 123456 123 456 123 456"
+<varname>FOO_remove</varname> = "123"
+<varname>FOO_remove</varname> = "456"</screen></para>
+ <para>In this example, <varname>FOO</varname> is now <literal>789 123456</literal>.</para>
+ </section>
+ <section>
<title>Conditional metadata set</title>
<para>OVERRIDES is a <quote>:</quote> separated variable containing each item you want to satisfy conditions. So, if you have a variable which is conditional on <quote>arm</quote>, and <quote>arm</quote> is in OVERRIDES, then the <quote>arm</quote> specific version of the variable is used rather than the non-conditional version. Example:</para>
<para><screen><varname>OVERRIDES</varname> = "architecture:os:machine"
@@ -536,7 +554,7 @@ options:
<example>
<title>Generating dependency graphs</title>
<para>BitBake is able to generate dependency graphs using the dot syntax. These graphs can be converted
-to images using the <application>dot</application> application from <ulink url="http://www.graphviz.org">Graphviz</ulink>.
+to images using the <application>dot</application> application from <ulink url="http://www.graphviz.org">Graphviz</ulink>.
Two files will be written into the current working directory, <emphasis>depends.dot</emphasis> containing dependency information at the package level and <emphasis>task-depends.dot</emphasis> containing a breakdown of the dependencies at the task level. To stop depending on common depends, one can use the <prompt>-I depend</prompt> to omit these from the graph. This can lead to more readable graphs. This way, <varname>DEPENDS</varname> from inherited classes such as base.bbclass can be removed from the graph.</para>
<screen><prompt>$ </prompt>bitbake -g blah</screen>
<screen><prompt>$ </prompt>bitbake -g -I virtual/whatever -I bloom blah</screen>