summaryrefslogtreecommitdiffstats
path: root/bitbake/doc
diff options
context:
space:
mode:
authorRichard Purdie <richard.purdie@linuxfoundation.org>2014-01-18 16:22:01 +0000
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-01-27 21:03:24 +0000
commit5cce95c6028ab610e148e4d6884330151881dd98 (patch)
tree3d32b6e00a7cf686b262bd8d7f95d8bcbc99e92f /bitbake/doc
parent2375f55045823e10940789479d910e1bce0be9b1 (diff)
downloadpoky-5cce95c6028ab610e148e4d6884330151881dd98.tar.gz
bitbake: user-manual-bitbakecommand: Standardise on section tags, not example
(Bitbake rev: c85a035608b7c862d964f45bb1b767fde072a1de) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'bitbake/doc')
-rw-r--r--bitbake/doc/user-manual/user-manual-bitbakecommand.xml61
1 files changed, 34 insertions, 27 deletions
diff --git a/bitbake/doc/user-manual/user-manual-bitbakecommand.xml b/bitbake/doc/user-manual/user-manual-bitbakecommand.xml
index a97f45ac40..c8163331be 100644
--- a/bitbake/doc/user-manual/user-manual-bitbakecommand.xml
+++ b/bitbake/doc/user-manual/user-manual-bitbakecommand.xml
@@ -4,7 +4,7 @@
4<chapter> 4<chapter>
5 <title>The BitBake command</title> 5 <title>The BitBake command</title>
6 6
7 <section> 7 <section id='bitbake-command-introduction'>
8 <title>Introduction</title> 8 <title>Introduction</title>
9 9
10 <para> 10 <para>
@@ -15,8 +15,10 @@
15 amongst them. 15 amongst them.
16 </para> 16 </para>
17 </section> 17 </section>
18 <section> 18
19 <section id='usage-and-syntax'>
19 <title>Usage and syntax</title> 20 <title>Usage and syntax</title>
21
20 <para> 22 <para>
21 <literallayout class='monospaced'> 23 <literallayout class='monospaced'>
22<prompt>$ </prompt>bitbake --help 24<prompt>$ </prompt>bitbake --help
@@ -92,10 +94,12 @@ Options:
92 94
93 </literallayout> 95 </literallayout>
94 </para> 96 </para>
95 <para> 97 </section>
96 98
97 <example> 99 <section id='bitbake-examples'>
100 <title>Examples</title>
98 101
102 <section id='example-executing-a-task-against-a-single-recipe'>
99 <title>Executing a task against a single .bb</title> 103 <title>Executing a task against a single .bb</title>
100 104
101 <para> 105 <para>
@@ -105,6 +109,7 @@ Options:
105 It obeys intertask dependencies when doing so. 109 It obeys intertask dependencies when doing so.
106 </para> 110 </para>
107 111
112 <para>
108 <para><quote>clean</quote> task:</para> 113 <para><quote>clean</quote> task:</para>
109 <literallayout class='monospaced'> 114 <literallayout class='monospaced'>
110 $ bitbake -b foo.bb -c clean 115 $ bitbake -b foo.bb -c clean
@@ -114,12 +119,11 @@ Options:
114 <literallayout class='monospaced'> 119 <literallayout class='monospaced'>
115 $ bitbake -b foo_1.0.bb 120 $ bitbake -b foo_1.0.bb
116 </literallayout> 121 </literallayout>
117
118 </example>
119 </para> 122 </para>
120 <para> 123 </section>
121 <example> 124
122 <title>Executing tasks against a set of .bb files</title> 125 <section id='executing-tasks-against-a-set-of-recipe-files'>
126 <title>Executing tasks against a set of .bb files</title>
123 <para> 127 <para>
124 There are a number of additional complexities introduced 128 There are a number of additional complexities introduced
125 when one wants to manage multiple .bb 129 when one wants to manage multiple .bb
@@ -159,8 +163,9 @@ Options:
159 $ bitbake -c clean virtual/whatever 163 $ bitbake -c clean virtual/whatever
160 </literallayout> 164 </literallayout>
161 </para> 165 </para>
162 </example> 166 </section>
163 <example> 167
168 <section id='generating-dependency-graphs'>
164 <title>Generating dependency graphs</title> 169 <title>Generating dependency graphs</title>
165 <para> 170 <para>
166 BitBake is able to generate dependency graphs using 171 BitBake is able to generate dependency graphs using
@@ -184,18 +189,17 @@ Options:
184 $ bitbake -g -I virtual/whatever -I bloom foo 189 $ bitbake -g -I virtual/whatever -I bloom foo
185 </literallayout> 190 </literallayout>
186 </para> 191 </para>
187 </example> 192 </section>
188 </para>
189 </section> 193 </section>
190 194
191 <section> 195 <section id='special-variables'>
192 <title>Special variables</title> 196 <title>Special variables</title>
193 197
194 <para> 198 <para>
195 Certain variables affect BitBake operation: 199 Certain variables affect BitBake operation:
196 </para> 200 </para>
197 201
198 <section> 202 <section id='bb-number-threads'>
199 <title><varname>BB_NUMBER_THREADS</varname></title> 203 <title><varname>BB_NUMBER_THREADS</varname></title>
200 204
201 <para> 205 <para>
@@ -204,8 +208,9 @@ Options:
204 </section> 208 </section>
205 </section> 209 </section>
206 210
207 <section> 211 <section id='bitbake-command-metadata'>
208 <title>Metadata</title> 212 <title>Metadata</title>
213
209 <para> 214 <para>
210 As you may have seen in the usage information, or in the 215 As you may have seen in the usage information, or in the
211 information about .bb files, the 216 information about .bb files, the
@@ -213,14 +218,14 @@ Options:
213 tool locates its files. 218 tool locates its files.
214 This variable is a space separated list of files 219 This variable is a space separated list of files
215 that are available, and supports wildcards. 220 that are available, and supports wildcards.
216 <example> 221 </para>
222 <section id='setting-bbfiles'>
217 <title>Setting BBFILES</title> 223 <title>Setting BBFILES</title>
218 224
225 <para>
219 <literallayout class='monospaced'> 226 <literallayout class='monospaced'>
220 BBFILES = "/path/to/bbfiles/*.bb" 227 BBFILES = "/path/to/bbfiles/*.bb"
221 </literallayout> 228 </literallayout>
222 </example></para>
223 <para>
224 With regard to dependencies, it expects the 229 With regard to dependencies, it expects the
225 .bb to define a 230 .bb to define a
226 <varname>DEPENDS</varname> variable, which contains a 231 <varname>DEPENDS</varname> variable, which contains a
@@ -230,8 +235,9 @@ Options:
230 set to a component of the .bb 235 set to a component of the .bb
231 filename by default. 236 filename by default.
232 </para> 237 </para>
238 </section>
233 239
234 <example> 240 <section id='depending-on-another-recipe-file'>
235 <title>Depending on another .bb</title> 241 <title>Depending on another .bb</title>
236 242
237 <para> 243 <para>
@@ -246,9 +252,9 @@ Options:
246 PN = "package-b" 252 PN = "package-b"
247 </literallayout> 253 </literallayout>
248 </para> 254 </para>
249 </example> 255 </section>
250 256
251 <example> 257 <section id='using-provides'>
252 <title>Using PROVIDES</title> 258 <title>Using PROVIDES</title>
253 259
254 <para> 260 <para>
@@ -274,15 +280,16 @@ This example shows the usage of the <varname>PROVIDES</varname> variable, which
274 gets used. 280 gets used.
275 There is, indeed, such a way. 281 There is, indeed, such a way.
276 </para> 282 </para>
283
277 <para> 284 <para>
278The following would go into a .conf file, to select package1: 285The following would go into a .conf file, to select package1:
279 <literallayout class='monospaced'> 286 <literallayout class='monospaced'>
280 PREFERRED_PROVIDER_virtual/package = "package1" 287 PREFERRED_PROVIDER_virtual/package = "package1"
281 </literallayout> 288 </literallayout>
282 </para> 289 </para>
283 </example> 290 </section>
284 291
285 <example> 292 <section id='specifying-version-preference'>
286 <title>Specifying version preference</title> 293 <title>Specifying version preference</title>
287 294
288 <para> 295 <para>
@@ -318,9 +325,9 @@ The following would go into a .conf file, to select package1:
318 </literallayout> 325 </literallayout>
319 326
320 </para> 327 </para>
321 </example> 328 </section>
322 <example>
323 329
330 <section id='using-recipe-file-collections'>
324 <title>Using <quote>bbfile collections</quote></title> 331 <title>Using <quote>bbfile collections</quote></title>
325 332
326 <para> 333 <para>
@@ -341,6 +348,6 @@ The following would go into a .conf file, to select package1:
341 BBFILE_PRIORITY_local = "10" 348 BBFILE_PRIORITY_local = "10"
342 </literallayout> 349 </literallayout>
343 </para> 350 </para>
344 </example> 351 </section>
345 </section> 352 </section>
346</chapter> 353</chapter>