diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2016-04-06 12:32:22 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2016-04-06 23:11:59 +0100 |
commit | 133224fb3189f0a1d1c32b83a04b923d53c4e397 (patch) | |
tree | 5db0eb243bea00586baf0fb02eb09a9a168a44f2 | |
parent | 3831ca0deeeffe512c32bb67cff94024e572ca29 (diff) | |
download | openembedded-core-contrib-133224fb3189f0a1d1c32b83a04b923d53c4e397.tar.gz |
documentation: Fixed references using the DISTRO_NAME variable
With the introduction of a DISTRO_NAME_NO_CAP variable, the occurrences
of the DISTRO_NAME variable had to be checked to see if they really
should be using the "NO_CAP" variable instead. Output and actual
branch names are case-sensitive.
(From yocto-docs rev: 711a3255538298dd3c4bd2af8ad13bc2d159c872)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 4 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-newbie.xml | 18 | ||||
-rw-r--r-- | documentation/poky.ent | 4 | ||||
-rw-r--r-- | documentation/sdk-manual/sdk-using.xml | 4 | ||||
-rw-r--r-- | documentation/toaster-manual/toaster-manual-setup-and-use.xml | 2 | ||||
-rw-r--r-- | documentation/yocto-project-qs/yocto-project-qs.xml | 10 |
6 files changed, 21 insertions, 21 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 372d7b788f..dc6ed46971 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -10180,8 +10180,8 @@ during your build. Here is an example: <literallayout class='monospaced'> - # We built using the &DISTRO_NAME; branch of the poky repo - $ git clone -b &DISTRO_NAME; git://git.yoctoproject.org/poky + # We built using the &DISTRO_NAME_NO_CAP; branch of the poky repo + $ git clone -b &DISTRO_NAME_NO_CAP; git://git.yoctoproject.org/poky $ cd poky # We built using the release_branch for our layers $ git clone -b release_branch git://git.mycompany.com/meta-my-bsp-layer diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index d72764d56b..6d4092f02c 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml @@ -976,7 +976,7 @@ Git uses "branches" to organize different development efforts. For example, the <filename>poky</filename> repository has several branches that include the current - <filename>&DISTRO_NAME;</filename> branch, the + <filename>&DISTRO_NAME_NO_CAP;</filename> branch, the <filename>master</filename> branch, and many branches for past Yocto Project releases. You can see all the branches by going to @@ -1008,14 +1008,14 @@ $ cd ~ $ git clone git://git.yoctoproject.org/poky $ cd poky - $ git checkout -b &DISTRO_NAME; origin/&DISTRO_NAME; + $ git checkout -b &DISTRO_NAME_NO_CAP; origin/&DISTRO_NAME_NO_CAP; </literallayout> In this example, the name of the top-level directory of your local <link linkend='source-directory'>Source Directory</link> is "poky" and the name of that local working area (local branch) - you just created and checked out is "&DISTRO_NAME;". + you just created and checked out is "&DISTRO_NAME_NO_CAP;". The files in your local repository now reflect the same files that - are in the "&DISTRO_NAME;" development branch of the + are in the "&DISTRO_NAME_NO_CAP;" development branch of the Yocto Project's "poky" upstream repository. It is important to understand that when you create and checkout a local working branch based on a branch name, @@ -1023,7 +1023,7 @@ at the time you created your local branch, which could be different from the files at the time of a similarly named release. In other words, creating and checking out a local branch based on - the "&DISTRO_NAME;" branch name is not the same as + the "&DISTRO_NAME_NO_CAP;" branch name is not the same as cloning and checking out the "master" branch. Keep reading to see how you create a local snapshot of a Yocto Project Release. @@ -1046,7 +1046,7 @@ <filename>dizzy-12.0.0</filename>, <filename>fido-13.0.0</filename>, <filename>jethro-14.0.0</filename>, and - <filename>&DISTRO_NAME;-&POKYVERSION;</filename>. + <filename>&DISTRO_NAME_NO_CAP;-&POKYVERSION;</filename>. These tags represent Yocto Project releases. </para> @@ -1064,14 +1064,14 @@ $ cd ~ $ git clone git://git.yoctoproject.org/poky $ cd poky - $ git checkout -b my-&DISTRO_NAME;-&POKYVERSION; &DISTRO_NAME;-&POKYVERSION; + $ git checkout -b my-&DISTRO_NAME_NO_CAP;-&POKYVERSION; &DISTRO_NAME_NO_CAP;-&POKYVERSION; </literallayout> In this example, the name of the top-level directory of your local Yocto Project Files Git repository is <filename>poky</filename>. And, the name of the local branch you have created and checked out is - <filename>my-&DISTRO_NAME;-&POKYVERSION;</filename>. + <filename>my-&DISTRO_NAME_NO_CAP;-&POKYVERSION;</filename>. The files in your repository now exactly match the Yocto Project &DISTRO; - Release tag (<filename>&DISTRO_NAME;-&POKYVERSION;</filename>). + Release tag (<filename>&DISTRO_NAME_NO_CAP;-&POKYVERSION;</filename>). It is important to understand that when you create and checkout a local working branch based on a tag, your environment matches a specific point in time and not the entire development branch. diff --git a/documentation/poky.ent b/documentation/poky.ent index f9ef62a327..673ab23c9c 100644 --- a/documentation/poky.ent +++ b/documentation/poky.ent @@ -5,7 +5,7 @@ <!ENTITY YOCTO_DOC_VERSION "2.1"> <!ENTITY POKYVERSION "15.0.0"> <!ENTITY POKYVERSION_COMPRESSED "1500"> -<!ENTITY YOCTO_POKY "poky-&DISTRO_NAME;-&POKYVERSION;"> +<!ENTITY YOCTO_POKY "poky-&DISTRO_NAME_NO_CAP;-&POKYVERSION;"> <!ENTITY COPYRIGHT_YEAR "2010-2016"> <!ENTITY YOCTO_DL_URL "http://downloads.yoctoproject.org"> <!ENTITY YOCTO_HOME_URL "http://www.yoctoproject.org"> @@ -15,7 +15,7 @@ <!ENTITY YOCTO_AB_URL "http://autobuilder.yoctoproject.org"> <!ENTITY YOCTO_GIT_URL "http://git.yoctoproject.org"> <!ENTITY YOCTO_ADTREPO_URL "http://adtrepo.yoctoproject.org"> -<!ENTITY YOCTO_RELEASE_NOTES "&YOCTO_HOME_URL;/downloads/core/&DISTRO_NAME;&DISTRO_COMPRESSED;"> +<!ENTITY YOCTO_RELEASE_NOTES "&YOCTO_HOME_URL;/downloads/core/&DISTRO_NAME_NO_CAP;&DISTRO_COMPRESSED;"> <!ENTITY OE_HOME_URL "http://www.openembedded.org"> <!ENTITY OE_LISTS_URL "http://lists.openembedded.org/mailman"> <!ENTITY OE_DOCS_URL "http://docs.openembedded.org"> diff --git a/documentation/sdk-manual/sdk-using.xml b/documentation/sdk-manual/sdk-using.xml index 618e57030f..1ea47d3bb0 100644 --- a/documentation/sdk-manual/sdk-using.xml +++ b/documentation/sdk-manual/sdk-using.xml @@ -842,10 +842,10 @@ <filename>luna/yocto-&DISTRO;</filename> tag, the <filename>master</filename> documentation branch, and - <filename>&DISTRO_NAME;</filename> for the + <filename>&DISTRO_NAME_NO_CAP;</filename> for the release name: <literallayout class='monospaced'> - $ ECLIPSE_HOME=/home/scottrif/eclipse-poky/scripts/eclipse ./build.sh luna/yocto-&DISTRO; master &DISTRO_NAME; 2>&1 | tee -a build.log + $ ECLIPSE_HOME=/home/scottrif/eclipse-poky/scripts/eclipse ./build.sh luna/yocto-&DISTRO; master &DISTRO_NAME_NO_CAP; 2>&1 | tee -a build.log </literallayout> After running the script, the file <filename>org.yocto.sdk-</filename><replaceable>release</replaceable><filename>-</filename><replaceable>date</replaceable><filename>-archive.zip</filename> diff --git a/documentation/toaster-manual/toaster-manual-setup-and-use.xml b/documentation/toaster-manual/toaster-manual-setup-and-use.xml index 12fe5839bd..e8fb168ce8 100644 --- a/documentation/toaster-manual/toaster-manual-setup-and-use.xml +++ b/documentation/toaster-manual/toaster-manual-setup-and-use.xml @@ -241,7 +241,7 @@ $ mkdir -p /var/www/toaster $ cd /var/www/toaster/ $ git clone git://git.yoctoproject.org/poky - $ git checkout &DISTRO_NAME; + $ git checkout &DISTRO_NAME_NO_CAP; </literallayout> </para></listitem> <listitem><para> diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml index 63e5cfb475..e769121930 100644 --- a/documentation/yocto-project-qs/yocto-project-qs.xml +++ b/documentation/yocto-project-qs/yocto-project-qs.xml @@ -360,7 +360,7 @@ remote: Total 226790 (delta 165212), reused 225887 (delta 164327) Receiving objects: 100% (226790/226790), 100.98 MiB | 263 KiB/s, done. Resolving deltas: 100% (165212/165212), done. - $ git checkout &DISTRO_NAME; + $ git checkout &DISTRO_NAME_NO_CAP; </literallayout> You can also get the Yocto Project Files by downloading Yocto Project releases from the @@ -464,12 +464,12 @@ Release: <literallayout class='monospaced'> $ cd ~/poky - $ git checkout -b &DISTRO_NAME; origin/&DISTRO_NAME; + $ git checkout -b &DISTRO_NAME_NO_CAP; origin/&DISTRO_NAME_NO_CAP; </literallayout> Git's <filename>checkout</filename> command checks out the current Yocto Project release into a local branch whose name matches the release (i.e. - <filename>&DISTRO_NAME;</filename>). + <filename>&DISTRO_NAME_NO_CAP;</filename>). The local branch tracks the upstream branch of the same name. Creating your own branch based on the released @@ -643,8 +643,8 @@ (<filename>meta-intel</filename> and <filename>poky</filename>) are using the same releases. Consequently, you need to checkout out the - "&DISTRO_NAME_NO_CAP;" release after cloning - <filename>meta-intel</filename>: + "<filename>&DISTRO_NAME_NO_CAP;</filename>" release after + cloning <filename>meta-intel</filename>: <literallayout class='monospaced'> $ cd $HOME/poky/meta-intel $ git checkout &DISTRO_NAME_NO_CAP; |