diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2012-01-23 11:32:12 -0600 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2012-01-30 16:06:01 +0000 |
commit | 1ad79777424cc9e155a06cdabf19a4c9b3aa66c7 (patch) | |
tree | 543a63e4d2582c425ca0cca9d56600bec26bc992 /documentation | |
parent | fe40f117c1154ee148e4ddcc512da031e43fbc0d (diff) | |
download | poky-1ad79777424cc9e155a06cdabf19a4c9b3aa66c7.tar.gz |
documentation/dev-manual: Changes to repo names and kernel example.
To make the kernel example more easily understood, Joshua Lock
suggested that the names used for the bare clone of the kernel
git repo and the copy of the bare clone be more different. So
I have changed the example such that the bare clone repo is
named linux-yocto-3.0-1.1.x.git and the copy of the bare clone
(or working repo) is named my-linux-yocto-3.0-1.1.x-work.
Note that this also implies the use of the linux-yocto_3.0-1.1.x
kernel and not the linux-yocto_3.0 kernel.
All the changes made here should take care of the example. I
did have to introduce a new figure that showed the kernel
repos based on the new names used in the example. Also, I had
to delete the other from this branch. The examples are now
diverging according to (master) work and 1.1.x work.
Reported-by: Joshua Lock <joshua.lock@intel.com>
(From yocto-docs rev: f4fdef6078fccfc2c72b6e0ad1dfae1f1ecb2aa6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/dev-manual/dev-manual-kernel-appendix.xml | 18 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-model.xml | 8 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-start.xml | 14 | ||||
-rw-r--r-- | documentation/dev-manual/figures/kernel-example-repos-edison.png | bin | 0 -> 25322 bytes | |||
-rw-r--r-- | documentation/dev-manual/figures/kernel-example-repos.png | bin | 24951 -> 0 bytes |
5 files changed, 22 insertions, 18 deletions
diff --git a/documentation/dev-manual/dev-manual-kernel-appendix.xml b/documentation/dev-manual/dev-manual-kernel-appendix.xml index ea59406696..12cb20eb46 100644 --- a/documentation/dev-manual/dev-manual-kernel-appendix.xml +++ b/documentation/dev-manual/dev-manual-kernel-appendix.xml | |||
@@ -65,7 +65,7 @@ | |||
65 | </para> | 65 | </para> |
66 | 66 | ||
67 | <para> | 67 | <para> |
68 | <imagedata fileref="figures/kernel-example-repos.png" width="7in" depth="5in" | 68 | <imagedata fileref="figures/kernel-example-repos-edison.png" width="7in" depth="5in" |
69 | align="center" scale="100" /> | 69 | align="center" scale="100" /> |
70 | </para> | 70 | </para> |
71 | 71 | ||
@@ -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 |
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. |
@@ -415,13 +415,13 @@ | |||
415 | <filename>poky-extras/meta-kernel-dev/recipes-kernel/linux</filename> | 415 | <filename>poky-extras/meta-kernel-dev/recipes-kernel/linux</filename> |
416 | directory, you need to identify the location of the | 416 | directory, you need to identify the location of the |
417 | local source code, which in this example is the bare clone named | 417 | local source code, which in this example is the bare clone named |
418 | <filename>linux-yocto-3.0.git</filename>. | 418 | <filename>linux-yocto-3.0-1.1.x.git</filename>. |
419 | To do this, set the <filename>KSRC_linux_yocto</filename> variable to point to your | 419 | To do this, set the <filename>KSRC_linux_yocto</filename> variable to point to your |
420 | local <filename>linux-yocto-3.0.git</filename> Git repository by adding the | 420 | local <filename>linux-yocto-3.0-1.1.x.git</filename> Git repository by adding the |
421 | following statement. | 421 | following statement. |
422 | Be sure to substitute your user information in the statement: | 422 | Be sure to substitute your user information in the statement: |
423 | <literallayout class='monospaced'> | 423 | <literallayout class='monospaced'> |
424 | KSRC_linux_yocto ?= /home/scottrif/linux-yocto-3.0.git | 424 | KSRC_linux_yocto ?= /home/scottrif/linux-yocto-3.0-1.1.x.git |
425 | </literallayout></para></listitem> | 425 | </literallayout></para></listitem> |
426 | <listitem><para><emphasis>Specify the Kernel Machine:</emphasis> Also in the | 426 | <listitem><para><emphasis>Specify the Kernel Machine:</emphasis> Also in the |
427 | <filename>linux-yocto_3.0.bbappend</filename> file, you need to specify | 427 | <filename>linux-yocto_3.0.bbappend</filename> file, you need to specify |
@@ -598,7 +598,7 @@ | |||
598 | <para> | 598 | <para> |
599 | After setting up the environment to run <filename>menuconfig</filename>, you are ready | 599 | After setting up the environment to run <filename>menuconfig</filename>, you are ready |
600 | to use the tool to interactively change the kernel configuration. | 600 | to use the tool to interactively change the kernel configuration. |
601 | In this example, we are basing our changes on the <filename>linux-yocto-3.0</filename> | 601 | In this example, we are basing our changes on the <filename>linux-yocto-3.0-1.1.x</filename> |
602 | kernel. | 602 | kernel. |
603 | The Yocto Project build environment recognizes this kernel as | 603 | The Yocto Project build environment recognizes this kernel as |
604 | <filename>linux-yocto</filename>. | 604 | <filename>linux-yocto</filename>. |
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index 4b625d1831..abe26e90a6 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml | |||
@@ -231,8 +231,12 @@ | |||
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 |
235 | Linux Yocto kernel that is based on the Linux 3.0 release.</para></listitem> | 235 | stable Linux Yocto kernel to use with the Yocto Project current (master) development. |
236 | This kernel is based on the Linux 3.0 release.</para></listitem> | ||
237 | <listitem><para><emphasis><filename>linux-yocto-3.0-1.1.x</filename></emphasis> - The | ||
238 | stable Linux Yocto kernel to use with the Yocto Project Release 1.1.x. | ||
239 | This kernel is based on the Linux 3.0 release.</para></listitem> | ||
236 | <listitem><para><emphasis><filename>linux-yocto-dev</filename></emphasis> - A development | 240 | <listitem><para><emphasis><filename>linux-yocto-dev</filename></emphasis> - A development |
237 | kernel based on the latest upstream release candidate available.</para></listitem> | 241 | kernel based on the latest upstream release candidate available.</para></listitem> |
238 | </itemizedlist> | 242 | </itemizedlist> |
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index 5cdc34be9c..d9f042bc61 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml | |||
@@ -117,18 +117,18 @@ | |||
117 | For simplicity, it is recommended that you create these structures outside of the | 117 | For simplicity, it is recommended that you create these structures outside of the |
118 | Yocto Project files' Git repository.</para> | 118 | Yocto Project files' Git repository.</para> |
119 | <para>As an example, the following transcript shows how to create the bare clone | 119 | <para>As an example, the following transcript shows how to create the bare clone |
120 | of the <filename>linux-yocto-3.0</filename> kernel and then create a copy of | 120 | of the <filename>linux-yocto-3.0-1.1.x</filename> kernel and then create a copy of |
121 | that clone. | 121 | that clone. |
122 | <note>When you have a local Linux Yocto kernel Git repository, you can | 122 | <note>When you have a local Linux Yocto kernel Git repository, you can |
123 | reference that repository rather than the upstream Git repository as | 123 | reference that repository rather than the upstream Git repository as |
124 | part of the <filename>clone</filename> command. | 124 | part of the <filename>clone</filename> command. |
125 | Doing so can speed up the process.</note> | 125 | Doing so can speed up the process.</note> |
126 | In the following example, the bare clone is named | 126 | In the following example, the bare clone is named |
127 | <filename>linux-yocto-3.0.git</filename>, while the | 127 | <filename>linux-yocto-3.0-1.1.x.git</filename>, while the |
128 | copy is named <filename>linux-yocto-3.0</filename>: | 128 | copy is named <filename>my-linux-yocto-3.0-1.1.x-work</filename>: |
129 | <literallayout class='monospaced'> | 129 | <literallayout class='monospaced'> |
130 | $ git clone --bare git://git.yoctoproject.org/linux-yocto-3.0 linux-yocto-3.0.git | 130 | $ git clone --bare git://git.yoctoproject.org/linux-yocto-3.0-1.1.x linux-yocto-3.0-1.1.x.git |
131 | Initialized empty Git repository in /home/scottrif/linux-yocto-3.0.git/ | 131 | Initialized empty Git repository in /home/scottrif/linux-yocto-3.0-1.1.x.git/ |
132 | remote: Counting objects: 2259181, done. | 132 | remote: Counting objects: 2259181, done. |
133 | remote: Compressing objects: 100% (373259/373259), done. | 133 | remote: Compressing objects: 100% (373259/373259), done. |
134 | remote: Total 2259181 (delta 1892638), reused 2231556 (delta 1865300) | 134 | remote: Total 2259181 (delta 1892638), reused 2231556 (delta 1865300) |
@@ -137,8 +137,8 @@ | |||
137 | </literallayout></para> | 137 | </literallayout></para> |
138 | <para>Now create a clone of the bare clone just created: | 138 | <para>Now create a clone of the bare clone just created: |
139 | <literallayout class='monospaced'> | 139 | <literallayout class='monospaced'> |
140 | $ git clone linux-yocto-3.0.git linux-yocto-3.0 | 140 | $ git clone linux-yocto-3.0-1.1.x.git my-linux-yocto-3.0-1.1.x-work |
141 | Initialized empty Git repository in /home/scottrif/linux-yocto-3.0/.git/ | 141 | Initialized empty Git repository in /home/scottrif/my-linux-yocto-3.0-1.1.x/.git/ |
142 | Checking out files: 100% (36898/36898), done. | 142 | Checking out files: 100% (36898/36898), done. |
143 | </literallayout></para></listitem> | 143 | </literallayout></para></listitem> |
144 | <listitem id='poky-extras-repo'><para><emphasis> | 144 | <listitem id='poky-extras-repo'><para><emphasis> |
diff --git a/documentation/dev-manual/figures/kernel-example-repos-edison.png b/documentation/dev-manual/figures/kernel-example-repos-edison.png new file mode 100644 index 0000000000..f442be967d --- /dev/null +++ b/documentation/dev-manual/figures/kernel-example-repos-edison.png | |||
Binary files differ | |||
diff --git a/documentation/dev-manual/figures/kernel-example-repos.png b/documentation/dev-manual/figures/kernel-example-repos.png deleted file mode 100644 index dce50bea0a..0000000000 --- a/documentation/dev-manual/figures/kernel-example-repos.png +++ /dev/null | |||
Binary files differ | |||