summaryrefslogtreecommitdiffstats
path: root/documentation/poky-ref-manual/ref-structure.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-10-22 14:16:22 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-10-23 00:03:14 +0100
commita73fde8caf889e52b16fd774652cf9bd08b14204 (patch)
tree7a23356968e88146257ff14fbf0efd72c97829a2 /documentation/poky-ref-manual/ref-structure.xml
parent2b51188de67f16423da2b0c0b3859b8900de6828 (diff)
downloadast2050-yocto-poky-a73fde8caf889e52b16fd774652cf9bd08b14204.zip
ast2050-yocto-poky-a73fde8caf889e52b16fd774652cf9bd08b14204.tar.gz
documentation: poky-ref-manual - Final changes before the 1.3 lockdown.
various changes as required. (From yocto-docs rev: 7f166508337c9d4aadad23997470a8871c5e42a4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/poky-ref-manual/ref-structure.xml')
-rw-r--r--documentation/poky-ref-manual/ref-structure.xml38
1 files changed, 19 insertions, 19 deletions
diff --git a/documentation/poky-ref-manual/ref-structure.xml b/documentation/poky-ref-manual/ref-structure.xml
index ece4894..be2773b 100644
--- a/documentation/poky-ref-manual/ref-structure.xml
+++ b/documentation/poky-ref-manual/ref-structure.xml
@@ -7,14 +7,14 @@
<title>Source Directory Structure</title>
<para>
- The <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink> consists of several components.
+ The <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> consists of several components.
Understanding them and knowing where they are located is key to using the Yocto Project well.
- This chapter describes the source directory and gives information about the various
+ This chapter describes the Source Directory and gives information about the various
files and directories.
</para>
<para>
- For information on how to establish a local source directory on your development system, see the
+ For information on how to establish a local Source Directory on your development system, see the
"<ulink url='&YOCTO_DOCS_DEV_URL;#getting-setup'>Getting Set Up</ulink>"
section in the Yocto Project Development Manual.
</para>
@@ -26,7 +26,7 @@
<title><filename>bitbake/</filename></title>
<para>
- The <ulink url='source-directory'>source directory</ulink>
+ The <ulink url='source-directory'>Source Directory</ulink>
includes a copy of BitBake for ease of use.
The copy usually matches the current stable BitBake release from the BitBake project.
BitBake, a metadata interpreter, reads the Yocto Project metadata and runs the tasks
@@ -39,7 +39,7 @@
When you run the <filename>bitbake</filename> command, the wrapper script in
<filename>scripts/</filename> is executed to run the main BitBake executable,
which resides in the <filename>bitbake/bin/</filename> directory.
- Sourcing the <link linkend="structure-core-script">oe-init-build-env</link>
+ Sourcing the <link linkend="structure-core-script">&OE_INIT_FILE;</link>
script places the <filename>scripts</filename> and <filename>bitbake/bin</filename>
directories (in that order) into the shell's <filename>PATH</filename> environment
variable.
@@ -59,19 +59,19 @@
This directory contains user configuration files and the output
generated by the OpenEmbedded build system in its standard configuration where
the source tree is combined with the output.
- The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>
+ The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
is created initially when you <filename>source</filename>
- the OpenEmbedded build environment setup script <filename>oe-init-build-env</filename>.
+ the OpenEmbedded build environment setup script <filename>&OE_INIT_FILE;</filename>.
</para>
<para>
It is also possible to place output and configuration
files in a directory separate from the
- <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>
+ <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
by providing a directory name when you <filename>source</filename>
the setup script.
- For information on separating output from your local source directory files, see <link
- linkend='structure-core-script'>oe-init-build-env</link>.
+ For information on separating output from your local Source Directory files, see <link
+ linkend='structure-core-script'>&OE_INIT_FILE;</link>.
</para>
</section>
@@ -141,7 +141,7 @@
<para>
This directory contains various integration scripts that implement
extra functionality in the Yocto Project environment (e.g. QEMU scripts).
- The <link linkend="structure-core-script">oe-init-build-env</link> script appends this
+ The <link linkend="structure-core-script">&OE_INIT_FILE;</link> script appends this
directory to the shell's <filename>PATH</filename> environment variable.
</para>
@@ -153,7 +153,7 @@
</section>
<section id='structure-core-script'>
- <title><filename>oe-init-build-env</filename></title>
+ <title><filename>&OE_INIT_FILE;</filename></title>
<para>
This script sets up the OpenEmbedded build environment.
@@ -166,16 +166,16 @@
</para>
<para>
- By default, running this script without a build directory argument creates the
+ By default, running this script without a Build Directory argument creates the
<filename>build</filename> directory.
- If you provide a build directory argument when you <filename>source</filename>
+ If you provide a Build Directory argument when you <filename>source</filename>
the script, you direct OpenEmbedded build system to create a
- <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink> of your choice.
- For example, the following command creates a build directory named
+ <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> of your choice.
+ For example, the following command creates a Build Directory named
<filename>mybuilds</filename> that is outside of the
- <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>:
+ <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>:
<literallayout class='monospaced'>
- $ source oe-init-build-env ~/mybuilds
+ $ source &OE_INIT_FILE; ~/mybuilds
</literallayout>
</para>
</section>
@@ -387,7 +387,7 @@
data.
Packages that need to share output with other packages do so within this directory.
The directory is subdivided by architecture so multiple builds can run within
- the one build directory.
+ the one Build Directory.
</para>
</section>
OpenPOWER on IntegriCloud