summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
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 /documentation/dev-manual
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>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml4
-rw-r--r--documentation/dev-manual/dev-manual-newbie.xml18
2 files changed, 11 insertions, 11 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.