summaryrefslogtreecommitdiffstats
path: root/bitbake/doc
diff options
context:
space:
mode:
authorRichard Purdie <richard.purdie@linuxfoundation.org>2014-01-18 16:14:52 +0000
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-01-27 21:03:24 +0000
commit2375f55045823e10940789479d910e1bce0be9b1 (patch)
tree360a43be1ba775dc1fed9c356237e11389ef789e /bitbake/doc
parent64f66d78215b3725345f160fabb094ece2972ec7 (diff)
downloadpoky-2375f55045823e10940789479d910e1bce0be9b1.tar.gz
bitbake: user-manual-bitbakecommand: Replace screen tags with literallayout
(Bitbake rev: 4fffe48ab607fd0d2f884186006ee168874b8414) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'bitbake/doc')
-rw-r--r--bitbake/doc/user-manual/user-manual-bitbakecommand.xml107
1 files changed, 68 insertions, 39 deletions
diff --git a/bitbake/doc/user-manual/user-manual-bitbakecommand.xml b/bitbake/doc/user-manual/user-manual-bitbakecommand.xml
index d3f4595d84..a97f45ac40 100644
--- a/bitbake/doc/user-manual/user-manual-bitbakecommand.xml
+++ b/bitbake/doc/user-manual/user-manual-bitbakecommand.xml
@@ -18,7 +18,8 @@
18 <section> 18 <section>
19 <title>Usage and syntax</title> 19 <title>Usage and syntax</title>
20 <para> 20 <para>
21 <screen><prompt>$ </prompt>bitbake --help 21 <literallayout class='monospaced'>
22<prompt>$ </prompt>bitbake --help
22Usage: bitbake [options] [recipename/target ...] 23Usage: bitbake [options] [recipename/target ...]
23 24
24 Executes the specified task (default is 'build') for a given set of target recipes (.bb files). 25 Executes the specified task (default is 'build') for a given set of target recipes (.bb files).
@@ -88,7 +89,8 @@ Options:
88 -m, --kill-server Terminate the remote server. 89 -m, --kill-server Terminate the remote server.
89 --observe-only Connect to a server as an observing-only client. 90 --observe-only Connect to a server as an observing-only client.
90 --status-only Check the status of the remote bitbake server. 91 --status-only Check the status of the remote bitbake server.
91 </screen> 92
93 </literallayout>
92 </para> 94 </para>
93 <para> 95 <para>
94 96
@@ -104,9 +106,15 @@ Options:
104 </para> 106 </para>
105 107
106 <para><quote>clean</quote> task:</para> 108 <para><quote>clean</quote> task:</para>
107 <para><screen><prompt>$ </prompt>bitbake -b blah_1.0.bb -c clean</screen></para> 109 <literallayout class='monospaced'>
110 $ bitbake -b foo.bb -c clean
111 </literallayout>
112
108 <para><quote>build</quote> task:</para> 113 <para><quote>build</quote> task:</para>
109 <para><screen><prompt>$ </prompt>bitbake -b blah_1.0.bb</screen></para> 114 <literallayout class='monospaced'>
115 $ bitbake -b foo_1.0.bb
116 </literallayout>
117
110 </example> 118 </example>
111 </para> 119 </para>
112 <para> 120 <para>
@@ -137,13 +145,20 @@ Options:
137 anything else. 145 anything else.
138 By default, a .bb generally PROVIDES its 146 By default, a .bb generally PROVIDES its
139 packagename, packagename-version, and packagename-version-revision. 147 packagename, packagename-version, and packagename-version-revision.
148 <literallayout class='monospaced'>
149 $ bitbake foo
150
151 $ bitbake foo-1.0
152
153 $ bitbake foo-1.0-r0
154
155 $ bitbake -c clean foo
156
157 $ bitbake virtual/whatever
158
159 $ bitbake -c clean virtual/whatever
160 </literallayout>
140 </para> 161 </para>
141 <screen><prompt>$ </prompt>bitbake blah</screen>
142 <screen><prompt>$ </prompt>bitbake blah-1.0</screen>
143 <screen><prompt>$ </prompt>bitbake blah-1.0-r0</screen>
144 <screen><prompt>$ </prompt>bitbake -c clean blah</screen>
145 <screen><prompt>$ </prompt>bitbake virtual/whatever</screen>
146 <screen><prompt>$ </prompt>bitbake -c clean virtual/whatever</screen>
147 </example> 162 </example>
148 <example> 163 <example>
149 <title>Generating dependency graphs</title> 164 <title>Generating dependency graphs</title>
@@ -163,9 +178,12 @@ Options:
163 This way, <varname>DEPENDS</varname> from inherited classes 178 This way, <varname>DEPENDS</varname> from inherited classes
164 such as base.bbclass can be removed from the 179 such as base.bbclass can be removed from the
165 graph. 180 graph.
181 <literallayout class='monospaced'>
182 $ bitbake -g foo
183
184 $ bitbake -g -I virtual/whatever -I bloom foo
185 </literallayout>
166 </para> 186 </para>
167 <screen><prompt>$ </prompt>bitbake -g blah</screen>
168 <screen><prompt>$ </prompt>bitbake -g -I virtual/whatever -I bloom blah</screen>
169 </example> 187 </example>
170 </para> 188 </para>
171 </section> 189 </section>
@@ -198,7 +216,9 @@ Options:
198 <example> 216 <example>
199 <title>Setting BBFILES</title> 217 <title>Setting BBFILES</title>
200 218
201 <programlisting><varname>BBFILES</varname> = "/path/to/bbfiles/*.bb"</programlisting> 219 <literallayout class='monospaced'>
220 BBFILES = "/path/to/bbfiles/*.bb"
221 </literallayout>
202 </example></para> 222 </example></para>
203 <para> 223 <para>
204 With regard to dependencies, it expects the 224 With regard to dependencies, it expects the
@@ -215,13 +235,16 @@ Options:
215 <title>Depending on another .bb</title> 235 <title>Depending on another .bb</title>
216 236
217 <para> 237 <para>
218a.bb: 238 <literallayout class='monospaced'>
219<screen>PN = "package-a" 239 a.bb:
220DEPENDS += "package-b"</screen> 240
221 </para> 241 PN = "package-a"
222 <para> 242 DEPENDS += "package-b"
223b.bb: 243
224<screen>PN = "package-b"</screen> 244 b.bb:
245
246 PN = "package-b"
247 </literallayout>
225 </para> 248 </para>
226 </example> 249 </example>
227 250
@@ -230,20 +253,19 @@ b.bb:
230 253
231 <para> 254 <para>
232This example shows the usage of the <varname>PROVIDES</varname> variable, which allows a given .bb to specify what functionality it provides. 255This example shows the usage of the <varname>PROVIDES</varname> variable, which allows a given .bb to specify what functionality it provides.
233</para> 256 <literallayout class='monospaced'>
234 <para> 257 package1.bb:
235package1.bb: 258
236<screen>PROVIDES += "virtual/package"</screen> 259 PROVIDES += "virtual/package"
237 </para> 260
238 <para> 261 package2.bb:
239package2.bb: 262
240<screen>DEPENDS += "virtual/package"</screen> 263 DEPENDS += "virtual/package"
241 </para> 264
242 <para> 265 package3.bb:
243package3.bb: 266
244<screen>PROVIDES += "virtual/package"</screen> 267 PROVIDES += "virtual/package"
245 </para> 268 </literallayout>
246 <para>
247 As you can see, we have two different 269 As you can see, we have two different
248 .bb's that provide the same functionality 270 .bb's that provide the same functionality
249 (virtual/package). 271 (virtual/package).
@@ -254,7 +276,9 @@ package3.bb:
254 </para> 276 </para>
255 <para> 277 <para>
256The following would go into a .conf file, to select package1: 278The following would go into a .conf file, to select package1:
257<screen>PREFERRED_PROVIDER_virtual/package = "package1"</screen> 279 <literallayout class='monospaced'>
280 PREFERRED_PROVIDER_virtual/package = "package1"
281 </literallayout>
258 </para> 282 </para>
259 </example> 283 </example>
260 284
@@ -289,7 +313,10 @@ The following would go into a .conf file, to select package1:
289 However, if we define the following variable in a 313 However, if we define the following variable in a
290 .conf that BitBake parses, we 314 .conf that BitBake parses, we
291 can change that. 315 can change that.
292 <screen>PREFERRED_VERSION_a = "1.1"</screen> 316 <literallayout class='monospaced'>
317 PREFERRED_VERSION_a = "1.1"
318 </literallayout>
319
293 </para> 320 </para>
294 </example> 321 </example>
295 <example> 322 <example>
@@ -305,13 +332,15 @@ The following would go into a .conf file, to select package1:
305 own local copy of an upstream repository, but with 332 own local copy of an upstream repository, but with
306 custom modifications that one does not want upstream. 333 custom modifications that one does not want upstream.
307 Usage: 334 Usage:
308 </para> 335 <literallayout class='monospaced'>
309 <screen> BBFILES = "/stuff/openembedded/*/*.bb /stuff/openembedded.modified/*/*.bb" 336 BBFILES = "/stuff/openembedded/*/*.bb /stuff/openembedded.modified/*/*.bb"
310 BBFILE_COLLECTIONS = "upstream local" 337 BBFILE_COLLECTIONS = "upstream local"
311 BBFILE_PATTERN_upstream = "^/stuff/openembedded/" 338 BBFILE_PATTERN_upstream = "^/stuff/openembedded/"
312 BBFILE_PATTERN_local = "^/stuff/openembedded.modified/" 339 BBFILE_PATTERN_local = "^/stuff/openembedded.modified/"
313 BBFILE_PRIORITY_upstream = "5" 340 BBFILE_PRIORITY_upstream = "5"
314 BBFILE_PRIORITY_local = "10"</screen> 341 BBFILE_PRIORITY_local = "10"
342 </literallayout>
343 </para>
315 </example> 344 </example>
316 </section> 345 </section>
317</chapter> 346</chapter>