summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBill Traynor <wmat@alphatroop.com>2013-04-25 12:54:10 -0400
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-01-13 22:00:28 +0000
commit4dc1a2506ea78dc0eb50b7f720296ddcb080408a (patch)
treeca2041746fcaa902d4528e6fae684bf04d357622
parent56a567a56d1c071618a62055318cfe45ea8158b1 (diff)
downloadbitbake-4dc1a2506ea78dc0eb50b7f720296ddcb080408a.tar.gz
user-manual-metadata: Formatting the copied content from YP.
Formatted the 'Running a Task' section that was copied from the YP Reference Manual for 80 column anherence. Signed-off-by: Bill Traynor <wmat@alphatroop.com>
-rw-r--r--doc/user-manual/user-manual-metadata.xml78
1 files changed, 42 insertions, 36 deletions
diff --git a/doc/user-manual/user-manual-metadata.xml b/doc/user-manual/user-manual-metadata.xml
index 2f221550d..444d14c52 100644
--- a/doc/user-manual/user-manual-metadata.xml
+++ b/doc/user-manual/user-manual-metadata.xml
@@ -572,19 +572,21 @@ need to import them.</para>
<para>
Tasks can either be a shell task or a Python task.
For shell tasks, BitBake writes a shell script to
- <filename>${WORKDIR}/temp/run.do_taskname.pid</filename> and then executes the script.
- The generated shell script contains all the exported variables, and the shell functions
- with all variables expanded.
- Output from the shell script goes to the file <filename>${WORKDIR}/temp/log.do_taskname.pid</filename>.
- Looking at the expanded shell functions in the run file and the output in the log files
- is a useful debugging technique.
+ <filename>${WORKDIR}/temp/run.do_taskname.pid</filename> and then
+ executes the script.
+ The generated shell script contains all the exported variables, and
+ the shell functions with all variables expanded.
+ Output from the shell script goes to the file
+ <filename>${WORKDIR}/temp/log.do_taskname.pid</filename>.
+ Looking at the expanded shell functions in the run file and the
+ output in the log files is a useful debugging technique.
</para>
<para>
- For Python tasks, BitBake executes the task internally and logs information to the
- controlling terminal.
- Future versions of BitBake will write the functions to files similar to the way
- shell tasks are handled.
+ For Python tasks, BitBake executes the task internally and logs
+ information to the controlling terminal.
+ Future versions of BitBake will write the functions to files
+ similar to the way shell tasks are handled.
Logging will be handled in a way similar to shell tasks as well.
</para>
@@ -593,31 +595,34 @@ need to import them.</para>
</para>
<para>
- When running a task, BitBake tightly controls the execution environment
- of the build tasks to make sure unwanted contamination from the build machine
- cannot influence the build.
+ When running a task, BitBake tightly controls the execution
+ environment of the build tasks to make sure unwanted contamination
+ from the build machine cannot influence the build.
Consequently, if you do want something to get passed into the build
task's environment, you must take a few steps:
<orderedlist>
- <listitem><para>Tell BitBake to load what you want from the environment
- into the data store.
- You can do so through the <filename>BB_ENV_EXTRAWHITE</filename>
- variable.
- For example, assume you want to prevent the build system from
- accessing your <filename>$HOME/.ccache</filename> directory.
+ <listitem><para>Tell BitBake to load what you want from the
+ environment into the data store.
+ You can do so through the
+ <filename>BB_ENV_EXTRAWHITE</filename> variable.
+ For example, assume you want to prevent the build system
+ from accessing your <filename>$HOME/.ccache</filename>
+ directory.
The following command tells BitBake to load
- <filename>CCACHE_DIR</filename> from the environment into the data
- store:
+ <filename>CCACHE_DIR</filename> from the environment into
+ the data store:
<literallayout class='monospaced'>
export BB_ENV_EXTRAWHITE="$BB_ENV_EXTRAWHITE CCACHE_DIR"
</literallayout></para></listitem>
- <listitem><para>Tell BitBake to export what you have loaded into the
- environment store to the task environment of every running task.
- Loading something from the environment into the data store
- (previous step) only makes it available in the datastore.
- To export it to the task environment of every running task,
- use a command similar to the following in your
- <filename>local.conf</filename> or distro configuration file:
+ <listitem><para>Tell BitBake to export what you have loaded into
+ the environment store to the task environment of every running
+ task.
+ Loading something from the environment into the data store
+ ()previous step) only makes it available in the datastore.
+ To export it to the task environment of every running task,
+ use a command similar to the following in your
+ <filename>local.conf</filename> or distro configuration
+ file:
<literallayout class='monospaced'>
export CCACHE_DIR
</literallayout></para></listitem>
@@ -625,14 +630,15 @@ need to import them.</para>
</para>
<note>
- A side effect of the previous steps is that BitBake records the variable
- as a dependency of the build process in things like the shared state
- checksums.
- If doing so results in unnecessary rebuilds of tasks, you can whitelist the
- variable so that the shared state code ignores the dependency when it creates
- checksums.
- For information on this process, see the <filename>BB_HASHBASE_WHITELIST</filename>
- example in the "<link linkend='checksums'>Checksums (Signatures)</link>" section.
+ A side effect of the previous steps is that BitBake records the
+ variable as a dependency of the build process in things like the
+ shared state checksums.
+ If doing so results in unnecessary rebuilds of tasks, you can
+ whitelist the variable so that the shared state code ignores the
+ dependency when it creates checksums.
+ For information on this process, see the
+ <filename>BB_HASHBASE_WHITELIST</filename> example in the
+ "<link linkend='checksums'>Checksums (Signatures)</link>" section.
</note>
</section>
<section>