summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
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:54 +0000
commit4cab968da8bda8d1bdc231417b3c8c9c9396ec10 (patch)
tree7e85df2b22e883d2b1ec17b49ab0ae266dd24548 /documentation/dev-manual
parent8b35d3fdfb68e2979636134719bb544fcf6a7938 (diff)
downloadpoky-4cab968da8bda8d1bdc231417b3c8c9c9396ec10.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: ae50d3ee3c244b2c864d80adf69a7a69fb6e3985) 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')
-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 cbb815a7f5..2625a44f2c 100644
--- a/documentation/dev-manual/dev-manual-newbie.xml
+++ b/documentation/dev-manual/dev-manual-newbie.xml
@@ -514,27 +514,40 @@
514 The <ulink url='&YOCTO_DOCS_REF_URL;#var-TOPDIR'><filename>TOPDIR</filename></ulink> 514 The <ulink url='&YOCTO_DOCS_REF_URL;#var-TOPDIR'><filename>TOPDIR</filename></ulink>
515 variable points to the Build Directory.</para> 515 variable points to the Build Directory.</para>
516 516
517 <para>You have a lot of flexibility when creating the Build Directory. 517 <para>
518 Following are some examples that show how to create the directory: 518 You have a lot of flexibility when creating the Build
519 Directory.
520 Following are some examples that show how to create the
521 directory.
522 The examples assume your
523 <link linkend='source-directory'>Source Directory</link> is
524 named <filename>poky</filename>:
519 <itemizedlist> 525 <itemizedlist>
520 <listitem><para>Create the Build Directory in your current working directory 526 <listitem><para>Create the Build Directory inside your
521 and name it <filename>build</filename>. 527 Source Directory and let the name of the Build
522 This is the default behavior. 528 Directory default to <filename>build</filename>:
523 <literallayout class='monospaced'> 529 <literallayout class='monospaced'>
524 $ source &OE_INIT_PATH; 530 $ cd $HOME/poky
531 $ source &OE_INIT_FILE;
525 </literallayout></para></listitem> 532 </literallayout></para></listitem>
526 <listitem><para>Provide a directory path and specifically name the build 533 <listitem><para>Create the Build Directory inside your
527 directory. 534 home directory and specifically name it
528 This next example creates a Build Directory named <filename>YP-&POKYVERSION;</filename> 535 <filename>test-builds</filename>:
529 in your home directory within the directory <filename>mybuilds</filename>.
530 If <filename>mybuilds</filename> does not exist, the directory is created for you:
531 <literallayout class='monospaced'> 536 <literallayout class='monospaced'>
532 $ source &OE_INIT_PATH; $HOME/mybuilds/YP-&POKYVERSION; 537 $ cd $HOME
538 $ source poky/&OE_INIT_FILE; test-builds
533 </literallayout></para></listitem> 539 </literallayout></para></listitem>
534 <listitem><para>Provide an existing directory to use as the Build Directory 540 <listitem><para>Provide a directory path and
535 and use the default <filename>build</filename> name. 541 specifically name the build directory.
542 Any intermediate folders in the pathname must
543 exist.
544 This next example creates a Build Directory named
545 <filename>YP-&POKYVERSION;</filename>
546 in your home directory within the existing
547 directory <filename>mybuilds</filename>:
536 <literallayout class='monospaced'> 548 <literallayout class='monospaced'>
537 $ source &OE_INIT_PATH; $HOME/mybuilds/ 549 $cd $HOME
550 $ source $HOME/poky/&OE_INIT_FILE; $HOME/mybuilds/YP-&POKYVERSION;
538 </literallayout></para></listitem> 551 </literallayout></para></listitem>
539 </itemizedlist> 552 </itemizedlist>
540 </para></listitem> 553 </para></listitem>