summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorKristi Rifenbark <kristi.rifenbark@gmail.com>2017-06-29 16:17:57 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-07-12 00:28:15 +0100
commit1d60050201b792c4536cd94e0c9a04fd122eb0d4 (patch)
tree325dbf1d430a0dff68bf3f3bc5fb82a304828549 /documentation
parentcb91fec7afc8f8a30f7ea836d4f0c7080a27a427 (diff)
downloadpoky-1d60050201b792c4536cd94e0c9a04fd122eb0d4.tar.gz
yocto-project-qs: Updated poky and meta-intel examples.
Fixes [YOCTO #11731] Updated examples to so they checkout by tag rather than by branch name. (From yocto-docs rev: 9dca9fdc315998612f4cd5c9c69e2b3e045562ad) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/yocto-project-qs/yocto-project-qs.xml56
1 files changed, 42 insertions, 14 deletions
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml
index 58e8a30766..78881d4185 100644
--- a/documentation/yocto-project-qs/yocto-project-qs.xml
+++ b/documentation/yocto-project-qs/yocto-project-qs.xml
@@ -403,7 +403,8 @@
403 <para> 403 <para>
404 Here is an example from an Ubuntu build host that clones the 404 Here is an example from an Ubuntu build host that clones the
405 <filename>poky</filename> repository and then checks out the 405 <filename>poky</filename> repository and then checks out the
406 latest Yocto Project Release (i.e. &DISTRO;): 406 latest Yocto Project Release by tag
407 (i.e. <filename>&DISTRO_REL_TAG;</filename>):
407 <literallayout class='monospaced'> 408 <literallayout class='monospaced'>
408 $ git clone git://git.yoctoproject.org/poky 409 $ git clone git://git.yoctoproject.org/poky
409 Cloning into 'poky'... 410 Cloning into 'poky'...
@@ -413,17 +414,32 @@
413 Receiving objects: 100% (361782/361782), 131.94 MiB | 6.88 MiB/s, done. 414 Receiving objects: 100% (361782/361782), 131.94 MiB | 6.88 MiB/s, done.
414 Resolving deltas: 100% (268619/268619), done. 415 Resolving deltas: 100% (268619/268619), done.
415 Checking connectivity... done. 416 Checking connectivity... done.
416 $ git checkout &DISTRO_NAME_NO_CAP; 417 $ git checkout tags/&DISTRO_REL_TAG; -b poky_&DISTRO;
417 </literallayout> 418 </literallayout>
418 You can also get the Yocto Project Files by downloading
419 Yocto Project releases from the
420 <ulink url="&YOCTO_HOME_URL;">Yocto Project website</ulink>.
421 </para> 419 </para>
422 420
423 <para> 421 <para>
424 For more information on getting set up with the Yocto Project 422 The previous Git <filename>checkout</filename> command
425 release, see the 423 creates a local branch named
426 "<link linkend='cloning-the-poky-repository'>Cloning the <filename>poky</filename> Repository</link>" 424 <filename>poky_&DISTRO;</filename>.
425 The files available to you in that branch exactly match the
426 repository's files in the
427 <filename>&DISTRO_NAME_NO_CAP;</filename>
428 development branch at the time of the Yocto Project &DISTRO;
429 release.
430 <note>
431 Rather than checking out the entire development branch
432 of a release (i.e. the tip), which could be continuously
433 changing while you are doing your development, you would
434 check out a branch based on a release tag. Doing so
435 provides you with an unchanging, stable set of files.
436 </note>
437 </para>
438
439 <para>
440 For more options and information about accessing Yocto
441 Project related repositories, see the
442 "<ulink url='&YOCTO_DOCS_DEV_URL;#working-with-yocto-project-source-files'>Working With Yocto Project Source Files</ulink>"
427 section in the Yocto Project Development Manual. 443 section in the Yocto Project Development Manual.
428 </para> 444 </para>
429 </section> 445 </section>
@@ -737,15 +753,27 @@
737 sure that both repositories 753 sure that both repositories
738 (<filename>meta-intel</filename> and 754 (<filename>meta-intel</filename> and
739 <filename>poky</filename>) are using the same releases. 755 <filename>poky</filename>) are using the same releases.
740 Consequently, you need to checkout out the 756 Because you used the <filename>&DISTRO_REL_TAG;</filename>
741 "<filename>&DISTRO_NAME_NO_CAP;</filename>" release after 757 tag when you checked out the <filename>poky</filename>
742 cloning <filename>meta-intel</filename>: 758 repository by tag, you should use a
759 <filename>meta-intel</filename>
760 tag that corresponds with the release you used for
761 <filename>poky</filename>. Consequently, you need to
762 checkout out the
763 "<filename>&METAINTELVERSION;-tbd-&YOCTO_DOC_VERSION;</filename>"
764 branch after cloning <filename>meta-intel</filename>:
743 <literallayout class='monospaced'> 765 <literallayout class='monospaced'>
744 $ cd $HOME/poky/meta-intel 766 $ cd $HOME/poky/meta-intel
745 $ git checkout &DISTRO_NAME_NO_CAP; 767 $ git checkout tags/&METAINTELVERSION;-tbd-&YOCTO_DOC_VERSION; -b meta-intel-&DISTRO_NAME_NO_CAP;-&YOCTO_DOC_VERSION;
746 Branch &DISTRO_NAME_NO_CAP; set up to track remote branch &DISTRO_NAME_NO_CAP; from origin. 768 Switched to a new branch 'meta-intel-&DISTRO_NAME_NO_CAP;-&YOCTO_DOC_VERSION;'
747 Switched to a new branch '&DISTRO_NAME_NO_CAP;'
748 </literallayout> 769 </literallayout>
770 The previous Git <filename>checkout</filename> command
771 creates a local branch named
772 <filename>meta-intel-&DISTRO_NAME_NO_CAP;-&YOCTO_DOC_VERSION;</filename>.
773 You have the option to name your local branch whatever
774 you want by providing any name you like for
775 "meta-intel-&DISTRO_NAME_NO_CAP;-&YOCTO_DOC_VERSION;"
776 in the above example.
749 </para></listitem> 777 </para></listitem>
750 <listitem><para><emphasis>Configure the Build:</emphasis> 778 <listitem><para><emphasis>Configure the Build:</emphasis>
751 To configure the build, you edit the 779 To configure the build, you edit the