summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r--documentation/dev-manual/dev-manual-bsp-appendix.xml20
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml4
-rw-r--r--documentation/dev-manual/dev-manual-kernel-appendix.xml28
-rw-r--r--documentation/dev-manual/dev-manual-model.xml3
-rw-r--r--documentation/dev-manual/dev-manual-newbie.xml3
-rw-r--r--documentation/dev-manual/dev-manual-start.xml14
6 files changed, 38 insertions, 34 deletions
diff --git a/documentation/dev-manual/dev-manual-bsp-appendix.xml b/documentation/dev-manual/dev-manual-bsp-appendix.xml
index fef07e5797..25f74763b1 100644
--- a/documentation/dev-manual/dev-manual-bsp-appendix.xml
+++ b/documentation/dev-manual/dev-manual-bsp-appendix.xml
@@ -43,7 +43,7 @@
43 $ git clone git://git.yoctoproject.org/poky 43 $ git clone git://git.yoctoproject.org/poky
44 $ cd poky 44 $ cd poky
45 </literallayout> 45 </literallayout>
46 Alternatively, you can start with the downloaded Poky "edison" tarball. 46 Alternatively, you can start with the downloaded Poky "&DISTRO_NAME;" tarball.
47 These commands unpack the tarball into a Yocto Project File directory structure. 47 These commands unpack the tarball into a Yocto Project File directory structure.
48 By default, the top-level directory of the file structure is named 48 By default, the top-level directory of the file structure is named
49 <filename>poky-&YOCTO_POKY;</filename>: 49 <filename>poky-&YOCTO_POKY;</filename>:
@@ -54,7 +54,7 @@
54 <note><para>If you're using the tarball method, you can ignore all the following steps that 54 <note><para>If you're using the tarball method, you can ignore all the following steps that
55 ask you to carry out Git operations. 55 ask you to carry out Git operations.
56 You already have the results of those operations 56 You already have the results of those operations
57 in the form of the edison release tarballs. 57 in the form of the &DISTRO_NAME; release tarballs.
58 Consequently, there is nothing left to do other than extract those tarballs into the 58 Consequently, there is nothing left to do other than extract those tarballs into the
59 proper locations.</para> 59 proper locations.</para>
60 60
@@ -160,7 +160,7 @@
160 $ cd meta-intel 160 $ cd meta-intel
161 </literallayout> 161 </literallayout>
162 Alternatively, you can start with the downloaded Crown Bay tarball. 162 Alternatively, you can start with the downloaded Crown Bay tarball.
163 You can download the edison version of the BSP tarball from the 163 You can download the &DISTRO_NAME; version of the BSP tarball from the
164 <ulink url='&YOCTO_HOME_URL;/download'>Download</ulink> page of the 164 <ulink url='&YOCTO_HOME_URL;/download'>Download</ulink> page of the
165 Yocto Project website. 165 Yocto Project website.
166 Here is the specific link for the tarball needed for this example: 166 Here is the specific link for the tarball needed for this example:
@@ -177,7 +177,7 @@
177 The <filename>meta-intel</filename> directory contains all the metadata 177 The <filename>meta-intel</filename> directory contains all the metadata
178 that supports BSP creation. 178 that supports BSP creation.
179 If you're using the Git method, the following 179 If you're using the Git method, the following
180 step will switch to the edison metadata. 180 step will switch to the &DISTRO_NAME; metadata.
181 If you're using the tarball method, you already have the correct metadata and can 181 If you're using the tarball method, you already have the correct metadata and can
182 skip to the next step. 182 skip to the next step.
183 Because <filename>meta-intel</filename> is its own Git repository, you will want 183 Because <filename>meta-intel</filename> is its own Git repository, you will want
@@ -445,11 +445,11 @@
445 and insert the commit identifiers to identify the kernel in which we 445 and insert the commit identifiers to identify the kernel in which we
446 are interested, which will be based on the <filename>atom-pc-standard</filename> 446 are interested, which will be based on the <filename>atom-pc-standard</filename>
447 kernel. 447 kernel.
448 In this case, because we're working with the edison branch of everything, we 448 In this case, because we're working with the &DISTRO_NAME; branch of everything, we
449 need to use the <filename>SRCREV</filename> values for the atom-pc branch 449 need to use the <filename>SRCREV</filename> values for the atom-pc branch
450 that are associated with the edison release. 450 that are associated with the &DISTRO_NAME; release.
451 To find those values, we need to find the <filename>SRCREV</filename> 451 To find those values, we need to find the <filename>SRCREV</filename>
452 values that edison uses for the atom-pc branch, which we find in the 452 values that &DISTRO_NAME; uses for the atom-pc branch, which we find in the
453 <filename>poky/meta-yocto/recipes-kernel/linux/linux-yocto_3.0.bbappend</filename> 453 <filename>poky/meta-yocto/recipes-kernel/linux/linux-yocto_3.0.bbappend</filename>
454 file. 454 file.
455 </para> 455 </para>
@@ -474,8 +474,8 @@
474 474
475 <para> 475 <para>
476 In this example, we're using the <filename>SRCREV</filename> values we 476 In this example, we're using the <filename>SRCREV</filename> values we
477 found already captured in the edison release because we're creating a BSP based on 477 found already captured in the &DISTRO_NAME; release because we're creating a BSP based on
478 edison. 478 &DISTRO_NAME;.
479 If, instead, we had based our BSP on the master branches, we would want to use 479 If, instead, we had based our BSP on the master branches, we would want to use
480 the most recent <filename>SRCREV</filename> values taken directly from the kernel repo. 480 the most recent <filename>SRCREV</filename> values taken directly from the kernel repo.
481 We will not be doing that for this example. 481 We will not be doing that for this example.
@@ -682,7 +682,7 @@
682 </para> 682 </para>
683 683
684 <para> 684 <para>
685 For reference, the sato image produced by the previous steps for edison 685 For reference, the sato image produced by the previous steps for &DISTRO_NAME;
686 should look like the following in terms of size. 686 should look like the following in terms of size.
687 If your sato image is much different from this, 687 If your sato image is much different from this,
688 you probably made a mistake in one of the above steps: 688 you probably made a mistake in one of the above steps:
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 7fd19cb54c..971a63655e 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -248,8 +248,8 @@
248 248
249 <para> 249 <para>
250 Append files files must have the same name as the underlying recipe. 250 Append files files must have the same name as the underlying recipe.
251 For example, the append file <filename>someapp_1.1.bbappend</filename> must 251 For example, the append file <filename>someapp_&DISTRO;.bbappend</filename> must
252 apply to <filename>someapp_1.1.bb</filename>. 252 apply to <filename>someapp_&DISTRO;.bb</filename>.
253 This means the original recipe and append file names are version number specific. 253 This means the original recipe and append file names are version number specific.
254 If the underlying recipe is renamed to update to a newer version, the 254 If the underlying recipe is renamed to update to a newer version, the
255 corresponding <filename>.bbappend</filename> file must be renamed as well. 255 corresponding <filename>.bbappend</filename> file must be renamed as well.
diff --git a/documentation/dev-manual/dev-manual-kernel-appendix.xml b/documentation/dev-manual/dev-manual-kernel-appendix.xml
index 58f33e8ef3..865c43b3ec 100644
--- a/documentation/dev-manual/dev-manual-kernel-appendix.xml
+++ b/documentation/dev-manual/dev-manual-kernel-appendix.xml
@@ -155,13 +155,13 @@
155 $ git branch -a 155 $ git branch -a
156 $ git tag -l 156 $ git tag -l
157 </literallayout> 157 </literallayout>
158 This example uses the Yocto Project 1.1 Release code named "edison", 158 This example uses the Yocto Project &DISTRO; Release code named "&DISTRO_NAME;",
159 which maps to the <filename>edison</filename> branch in the repository. 159 which maps to the <filename>&DISTRO_NAME;</filename> branch in the repository.
160 The following commands create and checkout the local <filename>edison</filename> 160 The following commands create and checkout the local <filename>&DISTRO_NAME;</filename>
161 branch: 161 branch:
162 <literallayout class='monospaced'> 162 <literallayout class='monospaced'>
163 $ git checkout -b &DISTRO_NAME; origin/&DISTRO_NAME; 163 $ git checkout -b &DISTRO_NAME; origin/&DISTRO_NAME;
164 Branch edison set up to track remote branch &DISTRO_NAME; from origin. 164 Branch &DISTRO_NAME; set up to track remote branch &DISTRO_NAME; from origin.
165 Switched to a new branch '&DISTRO_NAME;' 165 Switched to a new branch '&DISTRO_NAME;'
166 </literallayout> 166 </literallayout>
167 </para> 167 </para>
@@ -184,7 +184,7 @@
184 <title>Setting Up the Bare Clone and its Copy</title> 184 <title>Setting Up the Bare Clone and its Copy</title>
185 185
186 <para> 186 <para>
187 This example modifies the <filename>linux-yocto-3.0-1.1.x</filename> kernel. 187 This example modifies the <filename>linux-yocto-3.2</filename> kernel.
188 Thus, you need to create a bare clone of that kernel and then make a copy of the 188 Thus, you need to create a bare clone of that kernel and then make a copy of the
189 bare clone. 189 bare clone.
190 See the bulleted item 190 See the bulleted item
@@ -196,12 +196,12 @@
196 The bare clone exists for the kernel build tools and simply as the receiving end 196 The bare clone exists for the kernel build tools and simply as the receiving end
197 of <filename>git push</filename> 197 of <filename>git push</filename>
198 commands after you make edits and commits inside the copy of the clone. 198 commands after you make edits and commits inside the copy of the clone.
199 The copy (<filename>my-linux-yocto-3.0-1.1.x-work</filename> in this example) has to have 199 The copy (<filename>my-linux-yocto-3.2-work</filename> in this example) has to have
200 a local branch created and checked out for your work. 200 a local branch created and checked out for your work.
201 This example uses <filename>common-pc-base</filename> as the local branch. 201 This example uses <filename>common-pc-base</filename> as the local branch.
202 The following commands create and checkout the branch: 202 The following commands create and checkout the branch:
203 <literallayout class='monospaced'> 203 <literallayout class='monospaced'>
204 $ cd ~/my-linux-yocto-3.0-1.1.x-work 204 $ cd ~/my-linux-yocto-3.2-work
205 $ git checkout -b common-pc-base origin/yocto/standard/common-pc/base 205 $ git checkout -b common-pc-base origin/yocto/standard/common-pc/base
206 Branch common-pc-base set up to track remote branch 206 Branch common-pc-base set up to track remote branch
207 yocto/standard/common-pc/base from origin. 207 yocto/standard/common-pc/base from origin.
@@ -296,7 +296,7 @@
296 296
297 <para> 297 <para>
298 The file you change in this example is named <filename>calibrate.c</filename> 298 The file you change in this example is named <filename>calibrate.c</filename>
299 and is located in the <filename>my-linux-yocto-3.0-1.1.x-work</filename> Git repository 299 and is located in the <filename>my-linux-yocto-3.2-work</filename> Git repository
300 (the copy of the bare clone) in <filename>init</filename>. 300 (the copy of the bare clone) in <filename>init</filename>.
301 This example simply inserts several <filename>printk</filename> statements 301 This example simply inserts several <filename>printk</filename> statements
302 at the beginning of the <filename>calibrate_delay</filename> function. 302 at the beginning of the <filename>calibrate_delay</filename> function.
@@ -420,13 +420,13 @@
420 <filename>poky-extras/meta-kernel-dev/recipes-kernel/linux</filename> 420 <filename>poky-extras/meta-kernel-dev/recipes-kernel/linux</filename>
421 directory, you need to identify the location of the 421 directory, you need to identify the location of the
422 local source code, which in this example is the bare clone named 422 local source code, which in this example is the bare clone named
423 <filename>linux-yocto-3.0-1.1.x.git</filename>. 423 <filename>linux-yocto-3.2.git</filename>.
424 To do this, set the <filename>KSRC_linux_yocto</filename> variable to point to your 424 To do this, set the <filename>KSRC_linux_yocto</filename> variable to point to your
425 local <filename>linux-yocto-3.0-1.1.x.git</filename> Git repository by adding the 425 local <filename>linux-yocto-3.2.git</filename> Git repository by adding the
426 following statement. 426 following statement.
427 Be sure to substitute your user information in the statement: 427 Be sure to substitute your user information in the statement:
428 <literallayout class='monospaced'> 428 <literallayout class='monospaced'>
429 KSRC_linux_yocto ?= /home/scottrif/linux-yocto-3.0-1.1.x.git 429 KSRC_linux_yocto ?= /home/scottrif/linux-yocto-3.2.git
430 </literallayout></para></listitem> 430 </literallayout></para></listitem>
431 <listitem><para><emphasis>Specify the Kernel Machine:</emphasis> Also in the 431 <listitem><para><emphasis>Specify the Kernel Machine:</emphasis> Also in the
432 <filename>linux-yocto_3.0.bbappend</filename> file, you need to specify 432 <filename>linux-yocto_3.0.bbappend</filename> file, you need to specify
@@ -545,13 +545,13 @@
545 $ git branch -a 545 $ git branch -a
546 $ git tag -l 546 $ git tag -l
547 </literallayout> 547 </literallayout>
548 This example uses the Yocto Project 1.1.1 Release code named "&DISTRO_NAME;", 548 This example uses the Yocto Project &DISTRO; Release code named "&DISTRO_NAME;",
549 which maps to the <filename>&DISTRO_NAME;</filename> branch in the repository. 549 which maps to the <filename>&DISTRO_NAME;</filename> branch in the repository.
550 The following commands create and checkout the local <filename>&DISTRO_NAME;</filename> 550 The following commands create and checkout the local <filename>&DISTRO_NAME;</filename>
551 branch: 551 branch:
552 <literallayout class='monospaced'> 552 <literallayout class='monospaced'>
553 $ git checkout -b &DISTRO_NAME; origin/&DISTRO_NAME; 553 $ git checkout -b &DISTRO_NAME; origin/&DISTRO_NAME;
554 Branch edison set up to track remote branch &DISTRO_NAME; from origin. 554 Branch &DISTRO_NAME; set up to track remote branch &DISTRO_NAME; from origin.
555 Switched to a new branch '&DISTRO_NAME;' 555 Switched to a new branch '&DISTRO_NAME;'
556 </literallayout> 556 </literallayout>
557 </para> 557 </para>
@@ -654,7 +654,7 @@
654 <para> 654 <para>
655 After setting up the environment to run <filename>menuconfig</filename>, you are ready 655 After setting up the environment to run <filename>menuconfig</filename>, you are ready
656 to use the tool to interactively change the kernel configuration. 656 to use the tool to interactively change the kernel configuration.
657 In this example, we are basing our changes on the <filename>linux-yocto-3.0-1.1.x</filename> 657 In this example, we are basing our changes on the <filename>linux-yocto-3.2</filename>
658 kernel. 658 kernel.
659 The Yocto Project build environment recognizes this kernel as 659 The Yocto Project build environment recognizes this kernel as
660 <filename>linux-yocto</filename>. 660 <filename>linux-yocto</filename>.
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml
index 29840ee720..1950210644 100644
--- a/documentation/dev-manual/dev-manual-model.xml
+++ b/documentation/dev-manual/dev-manual-model.xml
@@ -247,6 +247,9 @@
247 <listitem><para><emphasis><filename>linux-yocto-3.0-1.1.x</filename></emphasis> - The 247 <listitem><para><emphasis><filename>linux-yocto-3.0-1.1.x</filename></emphasis> - The
248 stable Linux Yocto kernel to use with the Yocto Project Release 1.1.x. This kernel 248 stable Linux Yocto kernel to use with the Yocto Project Release 1.1.x. This kernel
249 is based on the Linux 3.0 release</para></listitem> 249 is based on the Linux 3.0 release</para></listitem>
250 <listitem><para><emphasis><filename>linux-yocto-3.2</filename></emphasis> - The
251 stable Linux Yocto kernel to use with the Yocto Project Release 1.2. This kernel
252 is based on the Linux 3.2 release</para></listitem>
250 <listitem><para><emphasis><filename>linux-yocto-dev</filename></emphasis> - A development 253 <listitem><para><emphasis><filename>linux-yocto-dev</filename></emphasis> - A development
251 kernel based on the latest upstream release candidate available.</para></listitem> 254 kernel based on the latest upstream release candidate available.</para></listitem>
252 </itemizedlist> 255 </itemizedlist>
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml
index 0cf9f3110f..132888a196 100644
--- a/documentation/dev-manual/dev-manual-newbie.xml
+++ b/documentation/dev-manual/dev-manual-newbie.xml
@@ -494,7 +494,8 @@
494 Git uses "branches" to organize different development efforts. 494 Git uses "branches" to organize different development efforts.
495 For example, the <filename>poky</filename> repository has 495 For example, the <filename>poky</filename> repository has
496 <filename>laverne</filename>, <filename>bernard</filename>, 496 <filename>laverne</filename>, <filename>bernard</filename>,
497 <filename>edison</filename>, and <filename>master</filename> branches among 497 <filename>edison</filename>, <filename>denzil</filename> and
498 <filename>master</filename> branches among
498 others. 499 others.
499 You can see all the branches by going to 500 You can see all the branches by going to
500 <ulink url='&YOCTO_GIT_URL;/cgit.cgi/poky/'></ulink> and 501 <ulink url='&YOCTO_GIT_URL;/cgit.cgi/poky/'></ulink> and
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index 02f6599179..791315c960 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -132,18 +132,18 @@
132 For simplicity, it is recommended that you create these structures outside of the 132 For simplicity, it is recommended that you create these structures outside of the
133 Yocto Project Files Git repository.</para> 133 Yocto Project Files Git repository.</para>
134 <para>As an example, the following transcript shows how to create the bare clone 134 <para>As an example, the following transcript shows how to create the bare clone
135 of the <filename>linux-yocto-3.0-1.1.x</filename> kernel and then create a copy of 135 of the <filename>linux-yocto-3.2</filename> kernel and then create a copy of
136 that clone. 136 that clone.
137 <note>When you have a local Linux Yocto kernel Git repository, you can 137 <note>When you have a local Linux Yocto kernel Git repository, you can
138 reference that repository rather than the upstream Git repository as 138 reference that repository rather than the upstream Git repository as
139 part of the <filename>clone</filename> command. 139 part of the <filename>clone</filename> command.
140 Doing so can speed up the process.</note></para> 140 Doing so can speed up the process.</note></para>
141 <para>In the following example, the bare clone is named 141 <para>In the following example, the bare clone is named
142 <filename>linux-yocto-3.0-1.1.x.git</filename>, while the 142 <filename>linux-yocto-3.2.git</filename>, while the
143 copy is named <filename>my-linux-yocto-3.0-1.1.x-work</filename>: 143 copy is named <filename>my-linux-yocto-3.2-work</filename>:
144 <literallayout class='monospaced'> 144 <literallayout class='monospaced'>
145 $ git clone --bare git://git.yoctoproject.org/linux-yocto-3.0-1.1.x linux-yocto-3.0-1.1.x.git 145 $ git clone --bare git://git.yoctoproject.org/linux-yocto-3.2 linux-yocto-3.2.git
146 Initialized empty Git repository in /home/scottrif/linux-yocto-3.0-1.1.x.git/ 146 Initialized empty Git repository in /home/scottrif/linux-yocto-3.2.git/
147 remote: Counting objects: 2259181, done. 147 remote: Counting objects: 2259181, done.
148 remote: Compressing objects: 100% (373259/373259), done. 148 remote: Compressing objects: 100% (373259/373259), done.
149 remote: Total 2259181 (delta 1892638), reused 2231556 (delta 1865300) 149 remote: Total 2259181 (delta 1892638), reused 2231556 (delta 1865300)
@@ -152,8 +152,8 @@
152 </literallayout></para> 152 </literallayout></para>
153 <para>Now create a clone of the bare clone just created: 153 <para>Now create a clone of the bare clone just created:
154 <literallayout class='monospaced'> 154 <literallayout class='monospaced'>
155 $ git clone linux-yocto-3.0-1.1.x.git my-linux-yocto-3.0-1.1.x-work 155 $ git clone linux-yocto-3.2.git my-linux-yocto-3.2-work
156 Initialized empty Git repository in /home/scottrif/my-linux-yocto-3.0-1.1.x/.git/ 156 Initialized empty Git repository in /home/scottrif/my-linux-yocto-3.2/.git/
157 Checking out files: 100% (36898/36898), done. 157 Checking out files: 100% (36898/36898), done.
158 </literallayout></para></listitem> 158 </literallayout></para></listitem>
159 <listitem id='poky-extras-repo'><para><emphasis> 159 <listitem id='poky-extras-repo'><para><emphasis>