summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/dev-manual-newbie.xml
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/dev-manual/dev-manual-newbie.xml')
-rw-r--r--documentation/dev-manual/dev-manual-newbie.xml93
1 files changed, 50 insertions, 43 deletions
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml
index 0ba560854d..0dc4bd58bb 100644
--- a/documentation/dev-manual/dev-manual-newbie.xml
+++ b/documentation/dev-manual/dev-manual-newbie.xml
@@ -662,54 +662,61 @@
662 use the <filename>.bb</filename> file extension.</para></listitem> 662 use the <filename>.bb</filename> file extension.</para></listitem>
663 <listitem> 663 <listitem>
664 <para id='source-directory'><emphasis>Source Directory:</emphasis> 664 <para id='source-directory'><emphasis>Source Directory:</emphasis>
665 This term refers to the directory structure created as a result of either downloading 665 This term refers to the directory structure created as a result
666 and unpacking a Yocto Project release tarball or creating a local copy of 666 of creating a local copy of the <filename>poky</filename> Git
667 the <filename>poky</filename> Git repository 667 repository <filename>git://git.yoctoproject.org/poky</filename>
668 <filename>git://git.yoctoproject.org/poky</filename>. 668 or expanding a released <filename>poky</filename> tarball.
669 Sometimes you might hear the term "poky directory" used to refer to this 669 Sometimes you might hear the term "poky directory" used to refer
670 directory structure. 670 to this directory structure.
671 <note> 671 <note>
672 The OpenEmbedded build system does not support file or directory names that 672 The OpenEmbedded build system does not support file or
673 contain spaces. 673 directory names that contain spaces.
674 Be sure that the Source Directory you use does not contain these types 674 Be sure that the Source Directory you use does not contain
675 of names. 675 these types of names.
676 </note></para> 676 </note></para>
677 <para>The Source Directory contains BitBake, Documentation, Metadata and 677
678 other files that all support the Yocto Project. 678 <para>The Source Directory contains BitBake, Documentation,
679 Consequently, you must have the Source Directory in place on your development 679 Metadata and other files that all support the Yocto Project.
680 system in order to do any development using the Yocto Project.</para> 680 Consequently, you must have the Source Directory in place on
681 681 your development system in order to do any development using
682 <para>For tarball expansion, the name of the top-level directory of the Source Directory 682 the Yocto Project.</para>
683 is derived from the Yocto Project release tarball. 683
684 For example, downloading and unpacking <filename>&YOCTO_POKY_TARBALL;</filename> 684 <para>When you create a local copy of the Git repository, you
685 results in a Source Directory whose top-level folder is named 685 can name the repository anything you like.
686 <filename>&YOCTO_POKY;</filename>. 686 Throughout much of the documentation, <filename>poky</filename>
687 If you create a local copy of the Git repository, you can name the repository 687 is used as the name of the top-level folder of the local copy of
688 anything you like. 688 the poky Git repository.
689 Throughout much of the documentation, <filename>poky</filename> is used as the name of 689 So, for example, cloning the <filename>poky</filename> Git
690 the top-level folder of the local copy of the poky Git repository. 690 repository results in a local Git repository whose top-level
691 So, for example, cloning the <filename>poky</filename> Git repository results in a 691 folder is also named <filename>poky</filename>.</para>
692 local Git repository whose top-level folder is also named <filename>poky</filename>.</para> 692
693 693 <para>While it is not recommended that you use tarball expansion
694 <para>It is important to understand the differences between the Source Directory created 694 to setup the Source Directory, if you do, the top-level
695 by unpacking a released tarball as compared to cloning 695 directory name of the Source Directory is derived from the
696 Yocto Project release tarball.
697 For example, downloading and unpacking
698 <filename>&YOCTO_POKY_TARBALL;</filename> results in a
699 Source Directory whose root folder is named
700 <filename>&YOCTO_POKY;</filename>.</para>
701
702 <para>It is important to understand the differences between the
703 Source Directory created by unpacking a released tarball as
704 compared to cloning
696 <filename>git://git.yoctoproject.org/poky</filename>. 705 <filename>git://git.yoctoproject.org/poky</filename>.
697 When you unpack a tarball, you have an exact copy of the files based on the time of 706 When you unpack a tarball, you have an exact copy of the files
698 release - a fixed release point. 707 based on the time of release - a fixed release point.
699 Any changes you make to your local files in the Source Directory are on top of the release. 708 Any changes you make to your local files in the Source Directory
700 On the other hand, when you clone the <filename>poky</filename> Git repository, you have an 709 are on top of the release and will remain local only.
701 active development repository. 710 On the other hand, when you clone the <filename>poky</filename>
702 In this case, any local changes you make to the Source Directory can be later applied 711 Git repository, you have an active development repository with
703 to active development branches of the upstream <filename>poky</filename> Git 712 access to the upstream repository's branches and tags.
713 In this case, any local changes you make to the local
714 Source Directory can be later applied to active development
715 branches of the upstream <filename>poky</filename> Git
704 repository.</para> 716 repository.</para>
705 717
706 <para>Finally, if you want to track a set of local changes while starting from the same point 718 <para>For more information on concepts related to Git
707 as a release tarball, you can create a local Git branch that 719 repositories, branches, and tags, see the
708 reflects the exact copy of the files at the time of their release.
709 You do this by using Git tags that are part of the repository.</para>
710
711 <para>For more information on concepts related to Git repositories, branches, and tags,
712 see the
713 "<link linkend='repositories-tags-and-branches'>Repositories, Tags, and Branches</link>" 720 "<link linkend='repositories-tags-and-branches'>Repositories, Tags, and Branches</link>"
714 section.</para></listitem> 721 section.</para></listitem>
715 <listitem><para><emphasis>Tasks:</emphasis> Arbitrary groups of software Recipes. 722 <listitem><para><emphasis>Tasks:</emphasis> Arbitrary groups of software Recipes.