aboutsummaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/dev-manual-newbie.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-11-11 08:55:53 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-12-03 12:53:07 +0000
commit6ac98af75ce994fd763b286fcd99adbee1d92851 (patch)
tree2a6b6385545b4e3987496a4983d3e9832f2f908a /documentation/dev-manual/dev-manual-newbie.xml
parent88312722890aa95c0f91e2b5ac72241f545c7bd1 (diff)
downloadopenembedded-core-contrib-6ac98af75ce994fd763b286fcd99adbee1d92851.tar.gz
dev-manual: Updated Build Directory term
The examples went stale. Two out of three did not work. I have provided new examples that work. Reporte-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 0a3695f3f6a5b31617f4a5da960677f87733b825) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual/dev-manual-newbie.xml')
-rw-r--r--documentation/dev-manual/dev-manual-newbie.xml43
1 files changed, 28 insertions, 15 deletions
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml
index 600c789a6d..d10f629a4a 100644
--- a/documentation/dev-manual/dev-manual-newbie.xml
+++ b/documentation/dev-manual/dev-manual-newbie.xml
@@ -510,27 +510,40 @@
The <ulink url='&YOCTO_DOCS_REF_URL;#var-TOPDIR'><filename>TOPDIR</filename></ulink>
variable points to the Build Directory.</para>
- <para>You have a lot of flexibility when creating the Build Directory.
- Following are some examples that show how to create the directory:
+ <para>
+ You have a lot of flexibility when creating the Build
+ Directory.
+ Following are some examples that show how to create the
+ directory.
+ The examples assume your
+ <link linkend='source-directory'>Source Directory</link> is
+ named <filename>poky</filename>:
<itemizedlist>
- <listitem><para>Create the Build Directory in your current working directory
- and name it <filename>build</filename>.
- This is the default behavior.
+ <listitem><para>Create the Build Directory inside your
+ Source Directory and let the name of the Build
+ Directory default to <filename>build</filename>:
<literallayout class='monospaced'>
- $ source &OE_INIT_PATH;
+ $ cd $HOME/poky
+ $ source &OE_INIT_FILE;
</literallayout></para></listitem>
- <listitem><para>Provide a directory path and specifically name the build
- directory.
- This next example creates a Build Directory named <filename>YP-&POKYVERSION;</filename>
- in your home directory within the directory <filename>mybuilds</filename>.
- If <filename>mybuilds</filename> does not exist, the directory is created for you:
+ <listitem><para>Create the Build Directory inside your
+ home directory and specifically name it
+ <filename>test-builds</filename>:
<literallayout class='monospaced'>
- $ source &OE_INIT_PATH; $HOME/mybuilds/YP-&POKYVERSION;
+ $ cd $HOME
+ $ source poky/&OE_INIT_FILE; test-builds
</literallayout></para></listitem>
- <listitem><para>Provide an existing directory to use as the Build Directory
- and use the default <filename>build</filename> name.
+ <listitem><para>Provide a directory path and
+ specifically name the build directory.
+ Any intermediate folders in the pathname must
+ exist.
+ This next example creates a Build Directory named
+ <filename>YP-&POKYVERSION;</filename>
+ in your home directory within the existing
+ directory <filename>mybuilds</filename>:
<literallayout class='monospaced'>
- $ source &OE_INIT_PATH; $HOME/mybuilds/
+ $cd $HOME
+ $ source $HOME/poky/&OE_INIT_FILE; $HOME/mybuilds/YP-&POKYVERSION;
</literallayout></para></listitem>
</itemizedlist>
</para></listitem>