summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-04-06 12:32:22 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-04-06 23:11:59 +0100
commit133224fb3189f0a1d1c32b83a04b923d53c4e397 (patch)
tree5db0eb243bea00586baf0fb02eb09a9a168a44f2
parent3831ca0deeeffe512c32bb67cff94024e572ca29 (diff)
downloadpoky-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.xml4
-rw-r--r--documentation/dev-manual/dev-manual-newbie.xml18
-rw-r--r--documentation/poky.ent4
-rw-r--r--documentation/sdk-manual/sdk-using.xml4
-rw-r--r--documentation/toaster-manual/toaster-manual-setup-and-use.xml2
-rw-r--r--documentation/yocto-project-qs/yocto-project-qs.xml10
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 @@
10180 during your build. 10180 during your build.
10181 Here is an example: 10181 Here is an example:
10182 <literallayout class='monospaced'> 10182 <literallayout class='monospaced'>
10183 # We built using the &DISTRO_NAME; branch of the poky repo 10183 # We built using the &DISTRO_NAME_NO_CAP; branch of the poky repo
10184 $ git clone -b &DISTRO_NAME; git://git.yoctoproject.org/poky 10184 $ git clone -b &DISTRO_NAME_NO_CAP; git://git.yoctoproject.org/poky
10185 $ cd poky 10185 $ cd poky
10186 # We built using the release_branch for our layers 10186 # We built using the release_branch for our layers
10187 $ git clone -b release_branch git://git.mycompany.com/meta-my-bsp-layer 10187 $ 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 @@
976 Git uses "branches" to organize different development efforts. 976 Git uses "branches" to organize different development efforts.
977 For example, the <filename>poky</filename> repository has 977 For example, the <filename>poky</filename> repository has
978 several branches that include the current 978 several branches that include the current
979 <filename>&DISTRO_NAME;</filename> branch, the 979 <filename>&DISTRO_NAME_NO_CAP;</filename> branch, the
980 <filename>master</filename> branch, and many branches for past 980 <filename>master</filename> branch, and many branches for past
981 Yocto Project releases. 981 Yocto Project releases.
982 You can see all the branches by going to 982 You can see all the branches by going to
@@ -1008,14 +1008,14 @@
1008 $ cd ~ 1008 $ cd ~
1009 $ git clone git://git.yoctoproject.org/poky 1009 $ git clone git://git.yoctoproject.org/poky
1010 $ cd poky 1010 $ cd poky
1011 $ git checkout -b &DISTRO_NAME; origin/&DISTRO_NAME; 1011 $ git checkout -b &DISTRO_NAME_NO_CAP; origin/&DISTRO_NAME_NO_CAP;
1012 </literallayout> 1012 </literallayout>
1013 In this example, the name of the top-level directory of your local 1013 In this example, the name of the top-level directory of your local
1014 <link linkend='source-directory'>Source Directory</link> 1014 <link linkend='source-directory'>Source Directory</link>
1015 is "poky" and the name of that local working area (local branch) 1015 is "poky" and the name of that local working area (local branch)
1016 you just created and checked out is "&DISTRO_NAME;". 1016 you just created and checked out is "&DISTRO_NAME_NO_CAP;".
1017 The files in your local repository now reflect the same files that 1017 The files in your local repository now reflect the same files that
1018 are in the "&DISTRO_NAME;" development branch of the 1018 are in the "&DISTRO_NAME_NO_CAP;" development branch of the
1019 Yocto Project's "poky" upstream repository. 1019 Yocto Project's "poky" upstream repository.
1020 It is important to understand that when you create and checkout a 1020 It is important to understand that when you create and checkout a
1021 local working branch based on a branch name, 1021 local working branch based on a branch name,
@@ -1023,7 +1023,7 @@
1023 at the time you created your local branch, which could be 1023 at the time you created your local branch, which could be
1024 different from the files at the time of a similarly named release. 1024 different from the files at the time of a similarly named release.
1025 In other words, creating and checking out a local branch based on 1025 In other words, creating and checking out a local branch based on
1026 the "&DISTRO_NAME;" branch name is not the same as 1026 the "&DISTRO_NAME_NO_CAP;" branch name is not the same as
1027 cloning and checking out the "master" branch. 1027 cloning and checking out the "master" branch.
1028 Keep reading to see how you create a local snapshot of a Yocto 1028 Keep reading to see how you create a local snapshot of a Yocto
1029 Project Release. 1029 Project Release.
@@ -1046,7 +1046,7 @@
1046 <filename>dizzy-12.0.0</filename>, 1046 <filename>dizzy-12.0.0</filename>,
1047 <filename>fido-13.0.0</filename>, 1047 <filename>fido-13.0.0</filename>,
1048 <filename>jethro-14.0.0</filename>, and 1048 <filename>jethro-14.0.0</filename>, and
1049 <filename>&DISTRO_NAME;-&POKYVERSION;</filename>. 1049 <filename>&DISTRO_NAME_NO_CAP;-&POKYVERSION;</filename>.
1050 These tags represent Yocto Project releases. 1050 These tags represent Yocto Project releases.
1051 </para> 1051 </para>
1052 1052
@@ -1064,14 +1064,14 @@
1064 $ cd ~ 1064 $ cd ~
1065 $ git clone git://git.yoctoproject.org/poky 1065 $ git clone git://git.yoctoproject.org/poky
1066 $ cd poky 1066 $ cd poky
1067 $ git checkout -b my-&DISTRO_NAME;-&POKYVERSION; &DISTRO_NAME;-&POKYVERSION; 1067 $ git checkout -b my-&DISTRO_NAME_NO_CAP;-&POKYVERSION; &DISTRO_NAME_NO_CAP;-&POKYVERSION;
1068 </literallayout> 1068 </literallayout>
1069 In this example, the name of the top-level directory of your local Yocto Project 1069 In this example, the name of the top-level directory of your local Yocto Project
1070 Files Git repository is <filename>poky</filename>. 1070 Files Git repository is <filename>poky</filename>.
1071 And, the name of the local branch you have created and checked out is 1071 And, the name of the local branch you have created and checked out is
1072 <filename>my-&DISTRO_NAME;-&POKYVERSION;</filename>. 1072 <filename>my-&DISTRO_NAME_NO_CAP;-&POKYVERSION;</filename>.
1073 The files in your repository now exactly match the Yocto Project &DISTRO; 1073 The files in your repository now exactly match the Yocto Project &DISTRO;
1074 Release tag (<filename>&DISTRO_NAME;-&POKYVERSION;</filename>). 1074 Release tag (<filename>&DISTRO_NAME_NO_CAP;-&POKYVERSION;</filename>).
1075 It is important to understand that when you create and checkout a local 1075 It is important to understand that when you create and checkout a local
1076 working branch based on a tag, your environment matches a specific point 1076 working branch based on a tag, your environment matches a specific point
1077 in time and not the entire development branch. 1077 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 @@
5<!ENTITY YOCTO_DOC_VERSION "2.1"> 5<!ENTITY YOCTO_DOC_VERSION "2.1">
6<!ENTITY POKYVERSION "15.0.0"> 6<!ENTITY POKYVERSION "15.0.0">
7<!ENTITY POKYVERSION_COMPRESSED "1500"> 7<!ENTITY POKYVERSION_COMPRESSED "1500">
8<!ENTITY YOCTO_POKY "poky-&DISTRO_NAME;-&POKYVERSION;"> 8<!ENTITY YOCTO_POKY "poky-&DISTRO_NAME_NO_CAP;-&POKYVERSION;">
9<!ENTITY COPYRIGHT_YEAR "2010-2016"> 9<!ENTITY COPYRIGHT_YEAR "2010-2016">
10<!ENTITY YOCTO_DL_URL "http://downloads.yoctoproject.org"> 10<!ENTITY YOCTO_DL_URL "http://downloads.yoctoproject.org">
11<!ENTITY YOCTO_HOME_URL "http://www.yoctoproject.org"> 11<!ENTITY YOCTO_HOME_URL "http://www.yoctoproject.org">
@@ -15,7 +15,7 @@
15<!ENTITY YOCTO_AB_URL "http://autobuilder.yoctoproject.org"> 15<!ENTITY YOCTO_AB_URL "http://autobuilder.yoctoproject.org">
16<!ENTITY YOCTO_GIT_URL "http://git.yoctoproject.org"> 16<!ENTITY YOCTO_GIT_URL "http://git.yoctoproject.org">
17<!ENTITY YOCTO_ADTREPO_URL "http://adtrepo.yoctoproject.org"> 17<!ENTITY YOCTO_ADTREPO_URL "http://adtrepo.yoctoproject.org">
18<!ENTITY YOCTO_RELEASE_NOTES "&YOCTO_HOME_URL;/downloads/core/&DISTRO_NAME;&DISTRO_COMPRESSED;"> 18<!ENTITY YOCTO_RELEASE_NOTES "&YOCTO_HOME_URL;/downloads/core/&DISTRO_NAME_NO_CAP;&DISTRO_COMPRESSED;">
19<!ENTITY OE_HOME_URL "http://www.openembedded.org"> 19<!ENTITY OE_HOME_URL "http://www.openembedded.org">
20<!ENTITY OE_LISTS_URL "http://lists.openembedded.org/mailman"> 20<!ENTITY OE_LISTS_URL "http://lists.openembedded.org/mailman">
21<!ENTITY OE_DOCS_URL "http://docs.openembedded.org"> 21<!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 @@
842 <filename>luna/yocto-&DISTRO;</filename> tag, the 842 <filename>luna/yocto-&DISTRO;</filename> tag, the
843 <filename>master</filename> documentation 843 <filename>master</filename> documentation
844 branch, and 844 branch, and
845 <filename>&DISTRO_NAME;</filename> for the 845 <filename>&DISTRO_NAME_NO_CAP;</filename> for the
846 release name: 846 release name:
847 <literallayout class='monospaced'> 847 <literallayout class='monospaced'>
848 $ ECLIPSE_HOME=/home/scottrif/eclipse-poky/scripts/eclipse ./build.sh luna/yocto-&DISTRO; master &DISTRO_NAME; 2>&amp;1 | tee -a build.log 848 $ ECLIPSE_HOME=/home/scottrif/eclipse-poky/scripts/eclipse ./build.sh luna/yocto-&DISTRO; master &DISTRO_NAME_NO_CAP; 2>&amp;1 | tee -a build.log
849 </literallayout> 849 </literallayout>
850 After running the script, the file 850 After running the script, the file
851 <filename>org.yocto.sdk-</filename><replaceable>release</replaceable><filename>-</filename><replaceable>date</replaceable><filename>-archive.zip</filename> 851 <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 @@
241 $ mkdir -p /var/www/toaster 241 $ mkdir -p /var/www/toaster
242 $ cd /var/www/toaster/ 242 $ cd /var/www/toaster/
243 $ git clone git://git.yoctoproject.org/poky 243 $ git clone git://git.yoctoproject.org/poky
244 $ git checkout &DISTRO_NAME; 244 $ git checkout &DISTRO_NAME_NO_CAP;
245 </literallayout> 245 </literallayout>
246 </para></listitem> 246 </para></listitem>
247 <listitem><para> 247 <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 @@
360 remote: Total 226790 (delta 165212), reused 225887 (delta 164327) 360 remote: Total 226790 (delta 165212), reused 225887 (delta 164327)
361 Receiving objects: 100% (226790/226790), 100.98 MiB | 263 KiB/s, done. 361 Receiving objects: 100% (226790/226790), 100.98 MiB | 263 KiB/s, done.
362 Resolving deltas: 100% (165212/165212), done. 362 Resolving deltas: 100% (165212/165212), done.
363 $ git checkout &DISTRO_NAME; 363 $ git checkout &DISTRO_NAME_NO_CAP;
364 </literallayout> 364 </literallayout>
365 You can also get the Yocto Project Files by downloading 365 You can also get the Yocto Project Files by downloading
366 Yocto Project releases from the 366 Yocto Project releases from the
@@ -464,12 +464,12 @@
464 Release: 464 Release:
465 <literallayout class='monospaced'> 465 <literallayout class='monospaced'>
466 $ cd ~/poky 466 $ cd ~/poky
467 $ git checkout -b &DISTRO_NAME; origin/&DISTRO_NAME; 467 $ git checkout -b &DISTRO_NAME_NO_CAP; origin/&DISTRO_NAME_NO_CAP;
468 </literallayout> 468 </literallayout>
469 Git's <filename>checkout</filename> command checks out 469 Git's <filename>checkout</filename> command checks out
470 the current Yocto Project release into a local branch 470 the current Yocto Project release into a local branch
471 whose name matches the release (i.e. 471 whose name matches the release (i.e.
472 <filename>&DISTRO_NAME;</filename>). 472 <filename>&DISTRO_NAME_NO_CAP;</filename>).
473 The local branch tracks the upstream branch of the 473 The local branch tracks the upstream branch of the
474 same name. 474 same name.
475 Creating your own branch based on the released 475 Creating your own branch based on the released
@@ -643,8 +643,8 @@
643 (<filename>meta-intel</filename> and 643 (<filename>meta-intel</filename> and
644 <filename>poky</filename>) are using the same releases. 644 <filename>poky</filename>) are using the same releases.
645 Consequently, you need to checkout out the 645 Consequently, you need to checkout out the
646 "&DISTRO_NAME_NO_CAP;" release after cloning 646 "<filename>&DISTRO_NAME_NO_CAP;</filename>" release after
647 <filename>meta-intel</filename>: 647 cloning <filename>meta-intel</filename>:
648 <literallayout class='monospaced'> 648 <literallayout class='monospaced'>
649 $ cd $HOME/poky/meta-intel 649 $ cd $HOME/poky/meta-intel
650 $ git checkout &DISTRO_NAME_NO_CAP; 650 $ git checkout &DISTRO_NAME_NO_CAP;