summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-10-23 15:44:48 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-11-01 17:09:50 +0000
commit37777b7da958fb4dd4a80eb3d3907a8ebe15d713 (patch)
tree8e4f55fbab490100021ee6ea989ec6c3f730da57
parentf762d40db07d8e0fdc5813c9d55762521998fa62 (diff)
downloadpoky-37777b7da958fb4dd4a80eb3d3907a8ebe15d713.tar.gz
yocto-project-qs: Updated "Building an Image" example to use Git repo
Fixes [YOCTO #5368] Partially addresses this issue, which is removal of examples that use a poky tarball. I changed the example so that it clones the upstream poky repo and then checks out a local branch named for the most recent release. (From yocto-docs rev: 58bd7cf3a09ccbe63b5349edb3d68f35e9eab339) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/yocto-project-qs/yocto-project-qs.xml43
1 files changed, 22 insertions, 21 deletions
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml
index 3606fe89a0..e8b92d7f82 100644
--- a/documentation/yocto-project-qs/yocto-project-qs.xml
+++ b/documentation/yocto-project-qs/yocto-project-qs.xml
@@ -414,9 +414,9 @@
414 414
415 <para> 415 <para>
416 <literallayout class='monospaced'> 416 <literallayout class='monospaced'>
417 $ wget &YOCTO_POKY_DL_URL; 417 $ git clone &YOCTO_GIT_URL;/git/poky
418 $ tar xjf &YOCTO_POKY;.tar.bz2 418 $ cd poky
419 $ cd &YOCTO_POKY; 419 $ git checkout -b &DISTRO_NAME; origin/&DISTRO_NAME;
420 $ source &OE_INIT_FILE; 420 $ source &OE_INIT_FILE;
421 </literallayout> 421 </literallayout>
422 </para> 422 </para>
@@ -433,30 +433,31 @@
433 </para></tip> 433 </para></tip>
434 434
435 <itemizedlist> 435 <itemizedlist>
436 <listitem><para>In the previous example, the first command retrieves the Yocto Project 436 <listitem><para>In the previous example, the first command uses
437 release tarball from the source repositories using the 437 <ulink url='&YOCTO_DOCS_DEV_URL;#git'>Git</ulink> to create
438 <filename>wget</filename> command. 438 a local repository named <filename>poky</filename> that is a
439 Alternatively, you can go to the 439 clone of the upstream Yocto Project
440 <ulink url='&YOCTO_HOME_URL;'>Yocto Project website's</ulink> 440 <filename>poky</filename> repository.</para></listitem>
441 "Downloads" page to retrieve the tarball.</para></listitem> 441 <listitem><para>The third command checks out a local branch and
442 <listitem><para>The second command extracts the files from the tarball and places 442 names it <filename>&DISTRO_NAME;</filename>.
443 them into a directory named <filename>&YOCTO_POKY;</filename> in the current 443 The local branch tracks the upstream branch of the same name.
444 directory.</para></listitem> 444 Creating your own branch based on the released branch ensures
445 <listitem><para>The third and fourth commands change the working directory to the 445 you are using the latest files for that release.
446 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> 446 </para></listitem>
447 and run the Yocto Project 447 <listitem><para>The final command runs the Yocto Project
448 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink> 448 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>
449 environment setup script. 449 environment setup script.
450 Running this script defines OpenEmbedded build environment settings needed to 450 Running this script defines OpenEmbedded build environment
451 complete the build. 451 settings needed to complete the build.
452 The script also creates the 452 The script also creates the
453 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, 453 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>,
454 which is <filename>build</filename> in this case and is located in the 454 which is <filename>build</filename> in this case and is located
455 Source Directory. 455 in the
456 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
456 After the script runs, your current working directory is set 457 After the script runs, your current working directory is set
457 to the Build Directory. 458 to the Build Directory.
458 Later, when the build completes, the Build Directory contains all the files 459 Later, when the build completes, the Build Directory contains
459 created during the build. 460 all the files created during the build.
460 <note> 461 <note>
461 For information on running a memory-resident BitBake, see 462 For information on running a memory-resident BitBake, see
462 the 463 the