summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-02-02 14:40:01 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-03-08 12:07:49 -0800
commitbabc066860bc936f5254dedc5d002d00ca7c2882 (patch)
tree1854d48e2adb5eef8551f87974698c97b847891a /documentation/dev-manual
parent9cfbefcc3d25a00054166aeaac49b873a2aa5cd0 (diff)
downloadpoky-babc066860bc936f5254dedc5d002d00ca7c2882.tar.gz
documentation/dev-manual: Updates to names of bare clone and copy
I changed the example to use a different kernel (linux-yocto-3.0-1.1.x) and the example that creates the bare clone and the copy of the bare clone to use better names that are more easily distiguishable: linux-yocto-3.0-1.1.x.git and my-linux-3.0-1.1.x-work, respectively. (From yocto-docs rev: b1366d35155121f5aa576715541036304c99f13b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r--documentation/dev-manual/dev-manual-kernel-appendix.xml16
-rw-r--r--documentation/dev-manual/dev-manual-model.xml5
-rw-r--r--documentation/dev-manual/dev-manual-start.xml14
3 files changed, 19 insertions, 16 deletions
diff --git a/documentation/dev-manual/dev-manual-kernel-appendix.xml b/documentation/dev-manual/dev-manual-kernel-appendix.xml
index 8eed4e63b4..0836fe9335 100644
--- a/documentation/dev-manual/dev-manual-kernel-appendix.xml
+++ b/documentation/dev-manual/dev-manual-kernel-appendix.xml
@@ -178,7 +178,7 @@
178 <title>Setting Up the Bare Clone and its Copy</title> 178 <title>Setting Up the Bare Clone and its Copy</title>
179 179
180 <para> 180 <para>
181 This example modifies the <filename>linux-yocto-3.0</filename> kernel. 181 This example modifies the <filename>linux-yocto-3.0-1.1.x</filename> kernel.
182 Thus, you need to create a bare clone of that kernel and then make a copy of the 182 Thus, you need to create a bare clone of that kernel and then make a copy of the
183 bare clone. 183 bare clone.
184 See the bulleted item 184 See the bulleted item
@@ -190,12 +190,12 @@
190 The bare clone exists for the kernel build tools and simply as the receiving end 190 The bare clone exists for the kernel build tools and simply as the receiving end
191 of <filename>git push</filename> 191 of <filename>git push</filename>
192 commands after you make edits and commits inside the copy of the clone. 192 commands after you make edits and commits inside the copy of the clone.
193 The copy (<filename>linux-yocto-3.0</filename> in this example) has to have 193 The copy (<filename>my-linux-yocto-3.0-1.1.x-work</filename> in this example) has to have
194 a local branch created and checked out for your work. 194 a local branch created and checked out for your work.
195 This example uses <filename>common-pc-base</filename> as the local branch. 195 This example uses <filename>common-pc-base</filename> as the local branch.
196 The following commands create and checkout the branch: 196 The following commands create and checkout the branch:
197 <literallayout class='monospaced'> 197 <literallayout class='monospaced'>
198 $ cd ~/linux-yocto-3.0 198 $ cd ~/my-linux-yocto-3.0-1.1.x-work
199 $ git checkout -b common-pc-base origin/yocto/standard/common-pc/base 199 $ git checkout -b common-pc-base origin/yocto/standard/common-pc/base
200 Branch common-pc-base set up to track remote branch 200 Branch common-pc-base set up to track remote branch
201 yocto/standard/common-pc/base from origin. 201 yocto/standard/common-pc/base from origin.
@@ -290,7 +290,7 @@
290 290
291 <para> 291 <para>
292 The file you change in this example is named <filename>calibrate.c</filename> 292 The file you change in this example is named <filename>calibrate.c</filename>
293 and is located in the <filename>linux-yocto-3.0</filename> Git repository 293 and is located in the <filename>my-linux-yocto-3.0-1.1.x-work</filename> Git repository
294 (the copy of the bare clone) in <filename>init</filename>. 294 (the copy of the bare clone) in <filename>init</filename>.
295 This example simply inserts several <filename>printk</filename> statements 295 This example simply inserts several <filename>printk</filename> statements
296 at the beginning of the <filename>calibrate_delay</filename> function. 296 at the beginning of the <filename>calibrate_delay</filename> function.
@@ -414,13 +414,13 @@
414 <filename>poky-extras/meta-kernel-dev/recipes-kernel/linux</filename> 414 <filename>poky-extras/meta-kernel-dev/recipes-kernel/linux</filename>
415 directory, you need to identify the location of the 415 directory, you need to identify the location of the
416 local source code, which in this example is the bare clone named 416 local source code, which in this example is the bare clone named
417 <filename>linux-yocto-3.0.git</filename>. 417 <filename>linux-yocto-3.0-1.1.x.git</filename>.
418 To do this, set the <filename>KSRC_linux_yocto</filename> variable to point to your 418 To do this, set the <filename>KSRC_linux_yocto</filename> variable to point to your
419 local <filename>linux-yocto-3.0.git</filename> Git repository by adding the 419 local <filename>linux-yocto-3.0-1.1.x.git</filename> Git repository by adding the
420 following statement. 420 following statement.
421 Be sure to substitute your user information in the statement: 421 Be sure to substitute your user information in the statement:
422 <literallayout class='monospaced'> 422 <literallayout class='monospaced'>
423 KSRC_linux_yocto ?= /home/scottrif/linux-yocto-3.0.git 423 KSRC_linux_yocto ?= /home/scottrif/linux-yocto-3.0-1.1.x.git
424 </literallayout></para></listitem> 424 </literallayout></para></listitem>
425 <listitem><para><emphasis>Specify the Kernel Machine:</emphasis> Also in the 425 <listitem><para><emphasis>Specify the Kernel Machine:</emphasis> Also in the
426 <filename>linux-yocto_3.0.bbappend</filename> file, you need to specify 426 <filename>linux-yocto_3.0.bbappend</filename> file, you need to specify
@@ -648,7 +648,7 @@
648 <para> 648 <para>
649 After setting up the environment to run <filename>menuconfig</filename>, you are ready 649 After setting up the environment to run <filename>menuconfig</filename>, you are ready
650 to use the tool to interactively change the kernel configuration. 650 to use the tool to interactively change the kernel configuration.
651 In this example, we are basing our changes on the <filename>linux-yocto-3.0</filename> 651 In this example, we are basing our changes on the <filename>linux-yocto-3.0-1.1.x</filename>
652 kernel. 652 kernel.
653 The Yocto Project build environment recognizes this kernel as 653 The Yocto Project build environment recognizes this kernel as
654 <filename>linux-yocto</filename>. 654 <filename>linux-yocto</filename>.
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml
index 673bf2997b..7c0302365b 100644
--- a/documentation/dev-manual/dev-manual-model.xml
+++ b/documentation/dev-manual/dev-manual-model.xml
@@ -231,8 +231,11 @@
231 stable Linux Yocto kernel that is based on the Linux 2.6.34 release.</para></listitem> 231 stable Linux Yocto kernel that is based on the Linux 2.6.34 release.</para></listitem>
232 <listitem><para><emphasis><filename>linux-yocto-2.6.37</filename></emphasis> - The 232 <listitem><para><emphasis><filename>linux-yocto-2.6.37</filename></emphasis> - The
233 stable Linux Yocto kernel that is based on the Linux 2.6.37 release.</para></listitem> 233 stable Linux Yocto kernel that is based on the Linux 2.6.37 release.</para></listitem>
234 <listitem><para><emphasis><filename>linux-yocto-3.0</filename></emphasis> - The current 234 <listitem><para><emphasis><filename>linux-yocto-3.0</filename></emphasis> - The stable
235 Linux Yocto kernel that is based on the Linux 3.0 release.</para></listitem> 235 Linux Yocto kernel that is based on the Linux 3.0 release.</para></listitem>
236 <listitem><para><emphasis><filename>linux-yocto-3.0-1.1.x</filename></emphasis> - The
237 stable Linux Yocto kernel to use with the Yocto Project Release 1.1.x. This kernel
238 is based on the Linux 3.0 release</para></listitem>
236 <listitem><para><emphasis><filename>linux-yocto-dev</filename></emphasis> - A development 239 <listitem><para><emphasis><filename>linux-yocto-dev</filename></emphasis> - A development
237 kernel based on the latest upstream release candidate available.</para></listitem> 240 kernel based on the latest upstream release candidate available.</para></listitem>
238 </itemizedlist> 241 </itemizedlist>
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index 3cb6750d54..007c751a4e 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -121,18 +121,18 @@
121 For simplicity, it is recommended that you create these structures outside of the 121 For simplicity, it is recommended that you create these structures outside of the
122 Yocto Project files' Git repository.</para> 122 Yocto Project files' Git repository.</para>
123 <para>As an example, the following transcript shows how to create the bare clone 123 <para>As an example, the following transcript shows how to create the bare clone
124 of the <filename>linux-yocto-3.0</filename> kernel and then create a copy of 124 of the <filename>linux-yocto-3.0-1.1.x</filename> kernel and then create a copy of
125 that clone. 125 that clone.
126 <note>When you have a local Linux Yocto kernel Git repository, you can 126 <note>When you have a local Linux Yocto kernel Git repository, you can
127 reference that repository rather than the upstream Git repository as 127 reference that repository rather than the upstream Git repository as
128 part of the <filename>clone</filename> command. 128 part of the <filename>clone</filename> command.
129 Doing so can speed up the process.</note></para> 129 Doing so can speed up the process.</note></para>
130 <para>In the following example, the bare clone is named 130 <para>In the following example, the bare clone is named
131 <filename>linux-yocto-3.0.git</filename>, while the 131 <filename>linux-yocto-3.0-1.1.x.git</filename>, while the
132 copy is named <filename>linux-yocto-3.0</filename>: 132 copy is named <filename>my-linux-yocto-3.0-1.1.x-work</filename>:
133 <literallayout class='monospaced'> 133 <literallayout class='monospaced'>
134 $ git clone --bare git://git.yoctoproject.org/linux-yocto-3.0 linux-yocto-3.0.git 134 $ git clone --bare git://git.yoctoproject.org/linux-yocto-3.0-1.1.x linux-yocto-3.0-1.1.x.git
135 Initialized empty Git repository in /home/scottrif/linux-yocto-3.0.git/ 135 Initialized empty Git repository in /home/scottrif/linux-yocto-3.0-1.1.x.git/
136 remote: Counting objects: 2259181, done. 136 remote: Counting objects: 2259181, done.
137 remote: Compressing objects: 100% (373259/373259), done. 137 remote: Compressing objects: 100% (373259/373259), done.
138 remote: Total 2259181 (delta 1892638), reused 2231556 (delta 1865300) 138 remote: Total 2259181 (delta 1892638), reused 2231556 (delta 1865300)
@@ -141,8 +141,8 @@
141 </literallayout></para> 141 </literallayout></para>
142 <para>Now create a clone of the bare clone just created: 142 <para>Now create a clone of the bare clone just created:
143 <literallayout class='monospaced'> 143 <literallayout class='monospaced'>
144 $ git clone linux-yocto-3.0.git linux-yocto-3.0 144 $ git clone linux-yocto-3.0-1.1.x.git my-linux-yocto-3.0-1.1.x-work
145 Initialized empty Git repository in /home/scottrif/linux-yocto-3.0/.git/ 145 Initialized empty Git repository in /home/scottrif/my-linux-yocto-3.0-1.1.x/.git/
146 Checking out files: 100% (36898/36898), done. 146 Checking out files: 100% (36898/36898), done.
147 </literallayout></para></listitem> 147 </literallayout></para></listitem>
148 <listitem id='poky-extras-repo'><para><emphasis> 148 <listitem id='poky-extras-repo'><para><emphasis>