summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2015-04-13 15:16:39 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2015-04-15 15:57:17 +0100
commit941910f47faf3863646ef8b7c95e5fb855355d5c (patch)
treec12413bbdaf819b31243786ebbc2022012e6dd9a
parent9d72edd0e67c2ade9bc4b96f410752af348c7fd9 (diff)
downloadpoky-941910f47faf3863646ef8b7c95e5fb855355d5c.tar.gz
ref-manual: Updated the section on oe-init-build-env-memres
Fixes [YOCTO #7559] Added some explanation on the syntax. As it was, the positionally dependent nature of the script's parameters was not accounted for. This is now explained. Also, talked a bit about the bitbake-cookerdaemon.log file. (From yocto-docs rev: fcf52a15acea2d75df9c84550d7e73c988ffb4bb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/ref-manual/ref-structure.xml58
1 files changed, 44 insertions, 14 deletions
diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml
index d3e503b3f7..48e39212a5 100644
--- a/documentation/ref-manual/ref-structure.xml
+++ b/documentation/ref-manual/ref-structure.xml
@@ -317,21 +317,42 @@
317 <literallayout class='monospaced'> 317 <literallayout class='monospaced'>
318 $ source oe-init-build-env-memres <replaceable>port_number</replaceable> <replaceable>build_dir</replaceable> 318 $ source oe-init-build-env-memres <replaceable>port_number</replaceable> <replaceable>build_dir</replaceable>
319 </literallayout> 319 </literallayout>
320 The script uses other scripts within the 320 Following are some considerations when sourcing this script:
321 <filename>scripts</filename> directory to do the bulk of the work. 321 <itemizedlist>
322 </para> 322 <listitem><para>
323 323 The script uses other scripts within the
324 <para> 324 <filename>scripts</filename> directory to do the bulk of
325 If you do not provide a port number with the script, the 325 the work.
326 BitBake server starts at a randomly selected port. 326 </para></listitem>
327 <listitem><para>
328 If you do not provide a port number with the script, the
329 BitBake server starts at a randomly selected port.
330 </para></listitem>
331 <listitem><para>
332 The script's parameters are positionally dependent.
333 Consequently, you cannot run the script and provide a
334 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
335 name without also providing a port number.
336 In other words, the following syntax is illegal:
337 <literallayout class='monospaced'>
338 $ source oe-initbuild-env-memres <replaceable>build_dir</replaceable>
339 </literallayout>
340 <note>
341 The previous restriction might be resolved in the
342 future.
343 See
344 <ulink url='https://bugzilla.yoctoproject.org/show_bug.cgi?id=7555'>Bug 7555</ulink>
345 for more information.
346 </note>
347 </para></listitem>
348 </itemizedlist>
327 </para> 349 </para>
328 350
329 <para> 351 <para>
330 When you run this script, your Yocto Project environment is set 352 When you run this script, your Yocto Project environment is set
331 up, a 353 up, a Build Directory is created, your working directory becomes
332 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> 354 the Build Directory, and you are presented with a list of common
333 is created, your working directory becomes the Build Directory, 355 BitBake targets.
334 and you are presented with a list of common BitBake targets.
335 Here is an example: 356 Here is an example:
336 <literallayout class='monospaced'> 357 <literallayout class='monospaced'>
337 $ source oe-init-build-env-memres 358 $ source oe-init-build-env-memres
@@ -349,6 +370,7 @@
349 meta-ide-support 370 meta-ide-support
350 371
351 You can also run generated qemu images with a command like 'runqemu qemux86' 372 You can also run generated qemu images with a command like 'runqemu qemux86'
373 Bitbake server address: 127.0.0.1, server port: 53995
352 Bitbake server started on demand as needed, use bitbake -m to shut it down 374 Bitbake server started on demand as needed, use bitbake -m to shut it down
353 </literallayout> 375 </literallayout>
354 The script gets its default list of common targets from the 376 The script gets its default list of common targets from the
@@ -369,16 +391,24 @@
369 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> 391 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
370 argument creates a build directory named 392 argument creates a build directory named
371 <filename>build</filename>. 393 <filename>build</filename>.
372 If you provide a Build Directory argument when you 394 If you provide a Build Directory argument and port number when you
373 <filename>source</filename> the script, the Build Directory is 395 <filename>source</filename> the script, the Build Directory is
374 created using that name. 396 created using that name.
375 For example, the following command starts the BitBake server using 397 For example, the following command starts the BitBake server using
376 a randomly selected port and creates a Build Directory named 398 port 53995 and creates a Build Directory named
377 <filename>mybuilds</filename> that is outside of the 399 <filename>mybuilds</filename> that is outside of the
378 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>: 400 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>:
379 <literallayout class='monospaced'> 401 <literallayout class='monospaced'>
380 $ source oe-init-build-env-memres ~/mybuilds 402 $ source oe-init-build-env-memres 53995 ~/mybuilds
381 </literallayout> 403 </literallayout>
404 The <filename>oe-init-build-env-memres</filename> script starts a
405 memory resident BitBake server.
406 This BitBake instance uses the
407 <filename>bitbake-cookerdaemon.log</filename> file, which is
408 located in the Build Directory.
409 </para>
410
411 <para>
382 The OpenEmbedded build system uses the template configuration 412 The OpenEmbedded build system uses the template configuration
383 files, which are found by default in the 413 files, which are found by default in the
384 <filename>meta-yocto/conf</filename> directory in the 414 <filename>meta-yocto/conf</filename> directory in the