summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-03-09 13:40:39 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-03-23 14:24:43 +0000
commitaa3a201629c7e40341f53d4be57b6e4223a845c8 (patch)
tree24e16d12dc67523d68b7c62eb2d9e8079bee8eb2 /documentation
parente9c32b6a856aa4be4ec47b5e361a4441446204f2 (diff)
downloadpoky-aa3a201629c7e40341f53d4be57b6e4223a845c8.tar.gz
documentation/dev-manual: Converted to use poky.ent
I converted the hard links to use the variables as established in the file poky.ent. Also, Cleaned up some bad text in the term "Yocto Project Files." Looks like a cut-and-paste problem. (From yocto-docs rev: e2e20bf4895d80dae73595e93132f37fb31121d1) 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-bsp-appendix.xml43
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml177
-rw-r--r--documentation/dev-manual/dev-manual-intro.xml33
-rw-r--r--documentation/dev-manual/dev-manual-kernel-appendix.xml34
-rw-r--r--documentation/dev-manual/dev-manual-model.xml77
-rw-r--r--documentation/dev-manual/dev-manual-newbie.xml129
-rw-r--r--documentation/dev-manual/dev-manual-start.xml53
-rw-r--r--documentation/dev-manual/dev-manual.xml9
8 files changed, 281 insertions, 274 deletions
diff --git a/documentation/dev-manual/dev-manual-bsp-appendix.xml b/documentation/dev-manual/dev-manual-bsp-appendix.xml
index f9c4383567..035549431f 100644
--- a/documentation/dev-manual/dev-manual-bsp-appendix.xml
+++ b/documentation/dev-manual/dev-manual-bsp-appendix.xml
@@ -1,5 +1,6 @@
1<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 1<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
3 4
4<appendix id='dev-manual-bsp-appendix'> 5<appendix id='dev-manual-bsp-appendix'>
5 6
@@ -45,10 +46,10 @@
45 Alternatively, you can start with the downloaded Poky "edison" tarball. 46 Alternatively, you can start with the downloaded Poky "edison" tarball.
46 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.
47 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
48 <filename>poky-edison-6.0</filename>: 49 <filename>poky-&YOCTO_POKY;</filename>:
49 <literallayout class='monospaced'> 50 <literallayout class='monospaced'>
50 $ tar xfj poky-edison-6.0.tar.bz2 51 $ tar xfj &YOCTO_POKY_TARBALL;
51 $ cd poky-edison-6.0 52 $ cd &YOCTO_POKY;
52 </literallayout> 53 </literallayout>
53 <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
54 ask you to carry out Git operations. 55 ask you to carry out Git operations.
@@ -85,24 +86,24 @@
85 $ git branch -a 86 $ git branch -a
86 $ git tag -l 87 $ git tag -l
87 </literallayout> 88 </literallayout>
88 For this example, we are going to use the Yocto Project 1.1 Release, which is code 89 For this example, we are going to use the Yocto Project &DISTRO; Release, which is code
89 named "edison". 90 named "&DISTRO_NAME;".
90 To make sure we have a local area (branch in Git terms) on our machine that 91 To make sure we have a local area (branch in Git terms) on our machine that
91 reflects the 1.1 release, we can use the following commands: 92 reflects the &DISTRO; release, we can use the following commands:
92 <literallayout class='monospaced'> 93 <literallayout class='monospaced'>
93 $ cd ~/poky 94 $ cd ~/poky
94 $ git fetch --tags 95 $ git fetch --tags
95 $ git checkout edison-6.0 -b edison 96 $ git checkout &DISTRO_NAME;-&POKYVERSION; -b &DISTRO_NAME;
96 Switched to a new branch 'edison' 97 Switched to a new branch '&DISTRO_NAME;'
97 </literallayout> 98 </literallayout>
98 The <filename>git fetch --tags</filename> is somewhat redundant since you just set 99 The <filename>git fetch --tags</filename> is somewhat redundant since you just set
99 up the repository and should have all the tags. 100 up the repository and should have all the tags.
100 The <filename>fetch</filename> command makes sure all the tags are available in your 101 The <filename>fetch</filename> command makes sure all the tags are available in your
101 local repository. 102 local repository.
102 The Git <filename>checkout</filename> command with the <filename>-b</filename> option 103 The Git <filename>checkout</filename> command with the <filename>-b</filename> option
103 creates a local branch for you named <filename>edison</filename>. 104 creates a local branch for you named <filename>&DISTRO_NAME;</filename>.
104 Your local branch begins in the same state as the Yocto Project 1.1 released tarball 105 Your local branch begins in the same state as the Yocto Project &DISTRO; released tarball
105 marked with the <filename>edison-6.0</filename> tag in the source repositories. 106 marked with the <filename>&DISTRO_NAME;-&POKYVERSION;</filename> tag in the source repositories.
106 </para> 107 </para>
107</section> 108</section>
108 109
@@ -160,14 +161,14 @@
160 </literallayout> 161 </literallayout>
161 Alternatively, you can start with the downloaded Crown Bay tarball. 162 Alternatively, you can start with the downloaded Crown Bay tarball.
162 You can download the edison version of the BSP tarball from the 163 You can download the edison version of the BSP tarball from the
163 <ulink url='http://www.yoctoproject.org/download'>Download</ulink> page of the 164 <ulink url='&YOCTO_HOME_URL;/download'>Download</ulink> page of the
164 Yocto Project website. 165 Yocto Project website.
165 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:
166 <ulink url='http://downloads.yoctoproject.org/releases/yocto/yocto-1.1/machines/crownbay-noemgd/crownbay-noemgd-edison-6.0.0.tar.bz2'></ulink>. 167 <ulink url='&YOCTO_MACHINES_DL_URL;/crownbay-noemgd/crownbay-noemgd-&DISTRO_NAME;-6.0.0.tar.bz2'></ulink>.
167 Again, be sure that you are already in the <filename>poky</filename> directory 168 Again, be sure that you are already in the <filename>poky</filename> directory
168 as described previously before installing the tarball: 169 as described previously before installing the tarball:
169 <literallayout class='monospaced'> 170 <literallayout class='monospaced'>
170 $ tar xfj crownbay-noemgd-edison-6.0.0.tar.bz2 171 $ tar xfj crownbay-noemgd-&DISTRO_NAME;-6.0.0.tar.bz2
171 $ cd meta-intel 172 $ cd meta-intel
172 </literallayout> 173 </literallayout>
173 </para> 174 </para>
@@ -181,10 +182,10 @@
181 skip to the next step. 182 skip to the next step.
182 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
183 to be sure you are in the appropriate branch for your work. 184 to be sure you are in the appropriate branch for your work.
184 For this example we are going to use the <filename>edison</filename> branch. 185 For this example we are going to use the <filename>&DISTRO_NAME;</filename> branch.
185 <literallayout class='monospaced'> 186 <literallayout class='monospaced'>
186 $ git checkout -b edison origin/edison 187 $ git checkout -b &DISTRO_NAME; origin/&DISTRO_NAME;
187 Switched to a new branch 'edison' 188 Switched to a new branch '&DISTRO_NAME;'
188 </literallayout> 189 </literallayout>
189 </para> 190 </para>
190</section> 191</section>
@@ -271,7 +272,7 @@
271 <filename>meta-mymachine/conf/layer.conf</filename>. 272 <filename>meta-mymachine/conf/layer.conf</filename>.
272 This file identifies build information needed for the new layer. 273 This file identifies build information needed for the new layer.
273 You can see the 274 You can see the
274 "<ulink url='http://www.yoctoproject.org/docs/latest/bsp-guide/bsp-guide.html#bsp-filelayout-layer'>Layer Configuration File</ulink>" section 275 "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-filelayout-layer'>Layer Configuration File</ulink>" section
275 in The Board Support Packages (BSP) Development Guide for more information on this configuration file. 276 in The Board Support Packages (BSP) Development Guide for more information on this configuration file.
276 Basically, we are changing the existing statements to work with our BSP. 277 Basically, we are changing the existing statements to work with our BSP.
277 </para> 278 </para>
@@ -483,7 +484,7 @@
483 the <filename>SRCREV</filename> statements. 484 the <filename>SRCREV</filename> statements.
484 You can find all the <filename>machine</filename> and <filename>meta</filename> 485 You can find all the <filename>machine</filename> and <filename>meta</filename>
485 branch points (commits) for the <filename>linux-yocto-3.0</filename> kernel at 486 branch points (commits) for the <filename>linux-yocto-3.0</filename> kernel at
486 <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/linux-yocto-3.0'></ulink>. 487 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/linux-yocto-3.0'></ulink>.
487 </para> 488 </para>
488 489
489 <para> 490 <para>
@@ -610,7 +611,7 @@
610 611
611 <para> 612 <para>
612 The appendix 613 The appendix
613 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#ref-variables-glos'> 614 <ulink url='&YOCTO_DOCS_REF_URL;#ref-variables-glos'>
614 Reference: Variables Glossary</ulink> in the Yocto Project Reference Manual has more information 615 Reference: Variables Glossary</ulink> in the Yocto Project Reference Manual has more information
615 on configuration variables. 616 on configuration variables.
616 </para> 617 </para>
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 4702ae94e3..74375c89bf 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -1,5 +1,6 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
3 4
4<chapter id='extendpoky'> 5<chapter id='extendpoky'>
5 6
@@ -60,8 +61,8 @@
60 and then explore that folder, you will discover many BSP layers within the 61 and then explore that folder, you will discover many BSP layers within the
61 <filename>meta-intel</filename> layer. 62 <filename>meta-intel</filename> layer.
62 For more information on BSP layers, see the 63 For more information on BSP layers, see the
63 "<ulink url='http://www.yoctoproject.org/docs/latest/bsp-guide/bsp-guide.html#bsp-layers'>BSP Layers</ulink>" 64 "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>"
64 section in the Yocto Project Development Manual. 65 section in the Yocto Project Board Support Package (BSP) Developer's Guide.
65 </para> 66 </para>
66 </section> 67 </section>
67 68
@@ -76,7 +77,7 @@
76 you should be sure someone has not already created a layer containing the metadata 77 you should be sure someone has not already created a layer containing the metadata
77 you need. 78 you need.
78 You can see the 79 You can see the
79 <ulink url='http://www.openembedded.org/wiki/LayerIndex'><filename>LayerIndex</filename></ulink> 80 <ulink url='&OE_HOME_URL;/wiki/LayerIndex'><filename>LayerIndex</filename></ulink>
80 for a list of layers from the OpenEmbedded community that can be used in the 81 for a list of layers from the OpenEmbedded community that can be used in the
81 Yocto Project.</para></listitem> 82 Yocto Project.</para></listitem>
82 <listitem><para><emphasis>Create a Directory:</emphasis> Create the directory 83 <listitem><para><emphasis>Create a Directory:</emphasis> Create the directory
@@ -108,24 +109,24 @@
108 BBFILE_PRIORITY_yocto = "5" 109 BBFILE_PRIORITY_yocto = "5"
109 </literallayout></para> 110 </literallayout></para>
110 <para>In the previous example, the recipes for the layers are added to 111 <para>In the previous example, the recipes for the layers are added to
111 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-BBFILES'>BBFILES</ulink></filename>. 112 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILES'>BBFILES</ulink></filename>.
112 The 113 The
113 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-BBFILE_COLLECTIONS'>BBFILE_COLLECTIONS</ulink></filename> 114 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILE_COLLECTIONS'>BBFILE_COLLECTIONS</ulink></filename>
114 variable is then appended with the layer name. 115 variable is then appended with the layer name.
115 The 116 The
116 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-BBFILE_PATTERN'>BBFILE_PATTERN</ulink></filename> 117 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILE_PATTERN'>BBFILE_PATTERN</ulink></filename>
117 variable is set to a regular expression and is used to match files 118 variable is set to a regular expression and is used to match files
118 from <filename>BBFILES</filename> into a particular layer. 119 from <filename>BBFILES</filename> into a particular layer.
119 In this case, immediate expansion of 120 In this case, immediate expansion of
120 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-LAYERDIR'>LAYERDIR</ulink></filename> 121 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-LAYERDIR'>LAYERDIR</ulink></filename>
121 sets <filename>BBFILES_PATTERN</filename> to the layer's path. 122 sets <filename>BBFILES_PATTERN</filename> to the layer's path.
122 The 123 The
123 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-BBFILE_PRIORITY'>BBFILE_PRIORITY</ulink></filename> 124 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILE_PRIORITY'>BBFILE_PRIORITY</ulink></filename>
124 variable then assigns a priority to the layer. 125 variable then assigns a priority to the layer.
125 Applying priorities is useful in situations where the same package might appear in multiple 126 Applying priorities is useful in situations where the same package might appear in multiple
126 layers and allows you to choose what layer should take precedence.</para> 127 layers and allows you to choose what layer should take precedence.</para>
127 <para>Note the use of the 128 <para>Note the use of the
128 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-LAYERDIR'>LAYERDIR</ulink></filename> 129 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-LAYERDIR'>LAYERDIR</ulink></filename>
129 variable with the immediate expansion operator. 130 variable with the immediate expansion operator.
130 The <filename>LAYERDIR</filename> variable expands to the directory of the current layer and 131 The <filename>LAYERDIR</filename> variable expands to the directory of the current layer and
131 requires the immediate expansion operator so that BitBake does not wait to expand the variable 132 requires the immediate expansion operator so that BitBake does not wait to expand the variable
@@ -199,7 +200,7 @@
199 <para> 200 <para>
200 Before the Yocto Project build system can use your new layer, you need to enable it. 201 Before the Yocto Project build system can use your new layer, you need to enable it.
201 To enable your layer, simply add your layer's path to the 202 To enable your layer, simply add your layer's path to the
202 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-BBLAYERS'>BBLAYERS</ulink></filename> 203 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'>BBLAYERS</ulink></filename>
203 variable in your <filename>conf/bblayers.conf</filename> file, which is found in the 204 variable in your <filename>conf/bblayers.conf</filename> file, which is found in the
204 <link linkend='yocto-project-build-directory'>Yocto Project Build Directory</link>. 205 <link linkend='yocto-project-build-directory'>Yocto Project Build Directory</link>.
205 The following example shows how to enable a layer named <filename>meta-mylayer</filename>: 206 The following example shows how to enable a layer named <filename>meta-mylayer</filename>:
@@ -290,12 +291,12 @@
290 PRINC = "1" 291 PRINC = "1"
291 </literallayout> 292 </literallayout>
292 This example adds or overrides files in 293 This example adds or overrides files in
293 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-SRC_URI'><filename>SRC_URI</filename></ulink> 294 <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink>
294 within a bbappend by extending the path BitBake uses to search for files. 295 within a bbappend by extending the path BitBake uses to search for files.
295 The most reliable way to do this is by prepending the 296 The most reliable way to do this is by prepending the
296 <filename>FILESEXTRAPATHS</filename> variable. 297 <filename>FILESEXTRAPATHS</filename> variable.
297 For example, if you have your files in a directory that is named the same as your package 298 For example, if you have your files in a directory that is named the same as your package
298 (<ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PN'><filename>PN</filename></ulink>), 299 (<ulink url='&YOCTO_DOCS_REF_URL;#var-PN'><filename>PN</filename></ulink>),
299 you can add this directory by adding the following to your bbappend file: 300 you can add this directory by adding the following to your bbappend file:
300 <literallayout class='monospaced'> 301 <literallayout class='monospaced'>
301 FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" 302 FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:"
@@ -328,7 +329,7 @@
328 329
329 <para> 330 <para>
330 To specify the layer's priority manually, use the 331 To specify the layer's priority manually, use the
331 <ulink url='http://yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-BBFILE_PRIORITY'><filename>BBFILE_PRIORITY</filename></ulink> 332 <ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILE_PRIORITY'><filename>BBFILE_PRIORITY</filename></ulink>
332 variable. 333 variable.
333 For example: 334 For example:
334 <literallayout class='monospaced'> 335 <literallayout class='monospaced'>
@@ -338,7 +339,7 @@
338 339
339 <note> 340 <note>
340 <para>It is possible for a recipe with a lower version number 341 <para>It is possible for a recipe with a lower version number
341 <ulink url='http://yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PV'><filename>PV</filename></ulink> 342 <ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink>
342 in a layer that has a higher priority to take precedence.</para> 343 in a layer that has a higher priority to take precedence.</para>
343 <para>Also, the layer priority does not currently affect the precedence order of 344 <para>Also, the layer priority does not currently affect the precedence order of
344 <filename>.conf</filename> or <filename>.bbclass</filename> files. 345 <filename>.conf</filename> or <filename>.bbclass</filename> files.
@@ -409,7 +410,8 @@
409 variables. 410 variables.
410 For information on variables that are useful for recipes and for information about recipe naming 411 For information on variables that are useful for recipes and for information about recipe naming
411 issues, see the 412 issues, see the
412 "<ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#ref-varlocality-recipe-required'>Required</ulink>" section of the Yocto Project Reference Manual. 413 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-varlocality-recipe-required'>Required</ulink>"
414 section of the Yocto Project Reference Manual.
413 </para> 415 </para>
414 416
415 <para> 417 <para>
@@ -434,12 +436,14 @@
434 Building an application from a single file that is stored locally (e.g. under 436 Building an application from a single file that is stored locally (e.g. under
435 <filename>files/</filename>) requires a recipe that has the file listed in 437 <filename>files/</filename>) requires a recipe that has the file listed in
436 the 438 the
437 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-SRC_URI'>SRC_URI</ulink></filename> variable. 439 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'>SRC_URI</ulink></filename>
440 variable.
438 Additionally, you need to manually write the <filename>do_compile</filename> and 441 Additionally, you need to manually write the <filename>do_compile</filename> and
439 <filename>do_install</filename> tasks. 442 <filename>do_install</filename> tasks.
440 The <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-S'>S</ulink></filename> variable defines the 443 The <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-S'>S</ulink></filename>
444 variable defines the
441 directory containing the source code, which is set to 445 directory containing the source code, which is set to
442 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-WORKDIR'> 446 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'>
443 WORKDIR</ulink></filename> in this case - the directory BitBake uses for the build. 447 WORKDIR</ulink></filename> in this case - the directory BitBake uses for the build.
444 <literallayout class='monospaced'> 448 <literallayout class='monospaced'>
445 DESCRIPTION = "Simple helloworld application" 449 DESCRIPTION = "Simple helloworld application"
@@ -477,7 +481,7 @@
477 <para> 481 <para>
478 Applications that use Autotools such as <filename>autoconf</filename> and 482 Applications that use Autotools such as <filename>autoconf</filename> and
479 <filename>automake</filename> require a recipe that has a source archive listed in 483 <filename>automake</filename> require a recipe that has a source archive listed in
480 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-SRC_URI'>SRC_URI</ulink></filename> and 484 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'>SRC_URI</ulink></filename> and
481 also inherits Autotools, which instructs BitBake to use the 485 also inherits Autotools, which instructs BitBake to use the
482 <filename>autotools.bbclass</filename> file, which contains the definitions of all the steps 486 <filename>autotools.bbclass</filename> file, which contains the definitions of all the steps
483 needed to build an Autotool-based application. 487 needed to build an Autotool-based application.
@@ -500,9 +504,9 @@
500 504
501 <para> 505 <para>
502 The variable 506 The variable
503 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</ulink></filename> 507 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</ulink></filename>
504 is used to track source license changes as described in the 508 is used to track source license changes as described in the
505 "<ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#usingpoky-configuring-LIC_FILES_CHKSUM'>Track License Change</ulink>" section. 509 "<ulink url='&YOCTO_DOCS_REF_URL;#usingpoky-configuring-LIC_FILES_CHKSUM'>Track License Change</ulink>" section.
506 You can quickly create Autotool-based recipes in a manner similar to the previous example. 510 You can quickly create Autotool-based recipes in a manner similar to the previous example.
507 </para> 511 </para>
508 </section> 512 </section>
@@ -512,11 +516,13 @@
512 516
513 <para> 517 <para>
514 Applications that use GNU <filename>make</filename> also require a recipe that has 518 Applications that use GNU <filename>make</filename> also require a recipe that has
515 the source archive listed in <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-SRC_URI'>SRC_URI</ulink></filename>. 519 the source archive listed in
520 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'>SRC_URI</ulink></filename>.
516 You do not need to add a <filename>do_compile</filename> step since by default BitBake 521 You do not need to add a <filename>do_compile</filename> step since by default BitBake
517 starts the <filename>make</filename> command to compile the application. 522 starts the <filename>make</filename> command to compile the application.
518 If you need additional <filename>make</filename> options you should store them in the 523 If you need additional <filename>make</filename> options you should store them in the
519 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-EXTRA_OEMAKE'>EXTRA_OEMAKE</ulink></filename> variable. 524 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_OEMAKE'>EXTRA_OEMAKE</ulink></filename>
525 variable.
520 BitBake passes these options into the <filename>make</filename> GNU invocation. 526 BitBake passes these options into the <filename>make</filename> GNU invocation.
521 Note that a <filename>do_install</filename> task is still required. 527 Note that a <filename>do_install</filename> task is still required.
522 Otherwise BitBake runs an empty <filename>do_install</filename> task by default. 528 Otherwise BitBake runs an empty <filename>do_install</filename> task by default.
@@ -526,7 +532,7 @@
526 Some applications might require extra parameters to be passed to the compiler. 532 Some applications might require extra parameters to be passed to the compiler.
527 For example, the application might need an additional header path. 533 For example, the application might need an additional header path.
528 You can accomplish this by adding to the 534 You can accomplish this by adding to the
529 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-CFLAGS'>CFLAGS</ulink></filename> variable. 535 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-CFLAGS'>CFLAGS</ulink></filename> variable.
530 The following example shows this: 536 The following example shows this:
531 <literallayout class='monospaced'> 537 <literallayout class='monospaced'>
532 CFLAGS_prepend = "-I ${S}/include " 538 CFLAGS_prepend = "-I ${S}/include "
@@ -568,9 +574,9 @@
568 574
569 <para> 575 <para>
570 You can use the variables 576 You can use the variables
571 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PACKAGES'>PACKAGES</ulink></filename> and 577 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES'>PACKAGES</ulink></filename> and
572 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-FILES'>FILES</ulink></filename> to split an application into 578 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-FILES'>FILES</ulink></filename>
573 multiple packages. 579 to split an application into multiple packages.
574 </para> 580 </para>
575 581
576 <para> 582 <para>
@@ -600,17 +606,17 @@
600 In the previous example, we want to ship the <filename>sxpm</filename> 606 In the previous example, we want to ship the <filename>sxpm</filename>
601 and <filename>cxpm</filename> binaries in separate packages. 607 and <filename>cxpm</filename> binaries in separate packages.
602 Since <filename>bindir</filename> would be packaged into the main 608 Since <filename>bindir</filename> would be packaged into the main
603 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PN'>PN</ulink></filename> 609 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PN'>PN</ulink></filename>
604 package by default, we prepend the 610 package by default, we prepend the
605 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PACKAGES'>PACKAGES</ulink> 611 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES'>PACKAGES</ulink>
606 </filename> variable so additional package names are added to the start of list. 612 </filename> variable so additional package names are added to the start of list.
607 This results in the extra 613 This results in the extra
608 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-FILES'>FILES</ulink></filename>_* 614 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-FILES'>FILES</ulink>_*</filename>
609 variables then containing information that define which files and 615 variables then containing information that define which files and
610 directories go into which packages. 616 directories go into which packages.
611 Files included by earlier packages are skipped by latter packages. 617 Files included by earlier packages are skipped by latter packages.
612 Thus, the main 618 Thus, the main
613 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PN'>PN</ulink></filename> package 619 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PN'>PN</ulink></filename> package
614 does not include the above listed files. 620 does not include the above listed files.
615 </para> 621 </para>
616 </section> 622 </section>
@@ -677,7 +683,7 @@
677 <filename>PACKAGENAME</filename> as the name of the package you want to attach to the 683 <filename>PACKAGENAME</filename> as the name of the package you want to attach to the
678 <filename>postinst</filename> script. 684 <filename>postinst</filename> script.
679 Normally 685 Normally
680 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PN'>PN</ulink></filename> 686 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PN'>PN</ulink></filename>
681 can be used, which automatically expands to PACKAGENAME. 687 can be used, which automatically expands to PACKAGENAME.
682 A post-installation function has the following structure: 688 A post-installation function has the following structure:
683 <literallayout class='monospaced'> 689 <literallayout class='monospaced'>
@@ -716,7 +722,7 @@
716 722
717 <para> 723 <para>
718 The previous example delays execution until the image boots again because the 724 The previous example delays execution until the image boots again because the
719 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-D'>D</ulink></filename> 725 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-D'>D</ulink></filename>
720 variable points 726 variable points
721 to the directory containing the image when the root filesystem is created at build time but 727 to the directory containing the image when the root filesystem is created at build time but
722 is unset when executed on the first boot. 728 is unset when executed on the first boot.
@@ -749,7 +755,8 @@
749 By creating a custom image, a developer has total control 755 By creating a custom image, a developer has total control
750 over the contents of the image. 756 over the contents of the image.
751 It is important to use the correct names of packages in the 757 It is important to use the correct names of packages in the
752 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-IMAGE_INSTALL'>IMAGE_INSTALL</ulink></filename> variable. 758 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'>IMAGE_INSTALL</ulink></filename>
759 variable.
753 You must use the OpenEmbedded notation and not the Debian notation for the names 760 You must use the OpenEmbedded notation and not the Debian notation for the names
754 (e.g. <filename>eglibc-dev</filename> instead of <filename>libc6-dev</filename>). 761 (e.g. <filename>eglibc-dev</filename> instead of <filename>libc6-dev</filename>).
755 </para> 762 </para>
@@ -775,13 +782,13 @@
775 A good example of a tasks package is 782 A good example of a tasks package is
776 <filename>meta/recipes-sato/tasks/task-poky.bb</filename>. 783 <filename>meta/recipes-sato/tasks/task-poky.bb</filename>.
777 The 784 The
778 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PACKAGES'>PACKAGES</ulink></filename> 785 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES'>PACKAGES</ulink></filename>
779 variable lists the task packages to build along with the complementary 786 variable lists the task packages to build along with the complementary
780 <filename>-dbg</filename> and <filename>-dev</filename> packages. 787 <filename>-dbg</filename> and <filename>-dev</filename> packages.
781 For each package added, you can use 788 For each package added, you can use
782 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-RDEPENDS'>RDEPENDS</ulink></filename> 789 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-RDEPENDS'>RDEPENDS</ulink></filename>
783 and 790 and
784 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-RRECOMMENDS'>RRECOMMENDS</ulink></filename> 791 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-RRECOMMENDS'>RRECOMMENDS</ulink></filename>
785 entries to provide a list of packages the parent task package should contain. 792 entries to provide a list of packages the parent task package should contain.
786 Following is an example: 793 Following is an example:
787 <literallayout class='monospaced'> 794 <literallayout class='monospaced'>
@@ -819,7 +826,7 @@
819 To build an image using these task packages, you need to add 826 To build an image using these task packages, you need to add
820 <filename>task-custom-apps</filename> and/or 827 <filename>task-custom-apps</filename> and/or
821 <filename>task-custom-tools</filename> to 828 <filename>task-custom-tools</filename> to
822 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-IMAGE_INSTALL'>IMAGE_INSTALL</ulink></filename>. 829 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'>IMAGE_INSTALL</ulink></filename>.
823 For other forms of image dependencies see the other areas of this section. 830 For other forms of image dependencies see the other areas of this section.
824 </para> 831 </para>
825 </section> 832 </section>
@@ -831,7 +838,7 @@
831 <para> 838 <para>
832 Ultimately users might want to add extra image features to the set used by 839 Ultimately users might want to add extra image features to the set used by
833 Yocto Project with the 840 Yocto Project with the
834 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-IMAGE_FEATURES'>IMAGE_FEATURES</ulink></filename> 841 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES'>IMAGE_FEATURES</ulink></filename>
835 variable. 842 variable.
836 To create these features, the best reference is 843 To create these features, the best reference is
837 <filename>meta/classes/core-image.bbclass</filename>, which shows how the 844 <filename>meta/classes/core-image.bbclass</filename>, which shows how the
@@ -840,12 +847,12 @@
840 <filename>IMAGE_FEATURES</filename> 847 <filename>IMAGE_FEATURES</filename>
841 variable and then maps that into a set of tasks or packages. 848 variable and then maps that into a set of tasks or packages.
842 Based on this information the 849 Based on this information the
843 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-IMAGE_INSTALL'> IMAGE_INSTALL</ulink></filename> 850 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'> IMAGE_INSTALL</ulink></filename>
844 variable is generated automatically. 851 variable is generated automatically.
845 Users can add extra features by extending the class or creating a custom class for use 852 Users can add extra features by extending the class or creating a custom class for use
846 with specialized image <filename>.bb</filename> files. 853 with specialized image <filename>.bb</filename> files.
847 You can also add more features by configuring the 854 You can also add more features by configuring the
848 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</ulink></filename> 855 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</ulink></filename>
849 variable in the <filename>local.conf</filename> file found in the Yocto Project 856 variable in the <filename>local.conf</filename> file found in the Yocto Project
850 files located in the build directory. 857 files located in the build directory.
851 </para> 858 </para>
@@ -882,7 +889,7 @@
882 889
883 <para> 890 <para>
884 The simplest way to add extra packages to all images is by using the 891 The simplest way to add extra packages to all images is by using the
885 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-IMAGE_INSTALL'>IMAGE_INSTALL</ulink></filename> 892 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'>IMAGE_INSTALL</ulink></filename>
886 variable with the <filename>_append</filename> operator: 893 variable with the <filename>_append</filename> operator:
887 <literallayout class='monospaced'> 894 <literallayout class='monospaced'>
888 IMAGE_INSTALL_append = " strace" 895 IMAGE_INSTALL_append = " strace"
@@ -917,7 +924,7 @@
917 924
918 <para> 925 <para>
919 You can add packages using a similar approach through the 926 You can add packages using a similar approach through the
920 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-POKY_EXTRA_INSTALL'>POKY_EXTRA_INSTALL</ulink></filename> 927 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-POKY_EXTRA_INSTALL'>POKY_EXTRA_INSTALL</ulink></filename>
921 variable. 928 variable.
922 If you use this variable, only <filename>core-image-*</filename> images are affected. 929 If you use this variable, only <filename>core-image-*</filename> images are affected.
923 </para> 930 </para>
@@ -930,7 +937,7 @@
930 It is possible to filter or mask out recipe and recipe append files such that 937 It is possible to filter or mask out recipe and recipe append files such that
931 BitBake ignores them. 938 BitBake ignores them.
932 You can do this by providing an expression with the 939 You can do this by providing an expression with the
933 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-BBMASK'>BBMASK</ulink></filename> 940 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBMASK'>BBMASK</ulink></filename>
934 variable. 941 variable.
935 Here is an example: 942 Here is an example:
936 <literallayout class='monospaced'> 943 <literallayout class='monospaced'>
@@ -1006,7 +1013,7 @@ so that there are some definite steps on how to do this. I need more detail her
1006 <para> 1013 <para>
1007 For a complete example that shows how to add a new machine to the Yocto Project, 1014 For a complete example that shows how to add a new machine to the Yocto Project,
1008 see the 1015 see the
1009 "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#dev-manual-bsp-appendix'>BSP Development Example</ulink>" 1016 "<ulink url='&YOCTO_DOCS_DEV_URL;#dev-manual-bsp-appendix'>BSP Development Example</ulink>"
1010 in Appendix A. 1017 in Appendix A.
1011 </para> 1018 </para>
1012 1019
@@ -1022,11 +1029,11 @@ so that there are some definite steps on how to do this. I need more detail her
1022 <para> 1029 <para>
1023 The most important variables to set in this file are as follows: 1030 The most important variables to set in this file are as follows:
1024 <itemizedlist> 1031 <itemizedlist>
1025 <listitem><para><filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-TARGET_ARCH'> 1032 <listitem><para><filename><ulink url='&YOCTO_DOCS_REF_URL;#var-TARGET_ARCH'>
1026 TARGET_ARCH</ulink></filename> (e.g. "arm")</para></listitem> 1033 TARGET_ARCH</ulink></filename> (e.g. "arm")</para></listitem>
1027 <listitem><para><filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PREFERRED_PROVIDER'> 1034 <listitem><para><filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PREFERRED_PROVIDER'>
1028 PREFERRED_PROVIDER</ulink></filename>_virtual/kernel (see below)</para></listitem> 1035 PREFERRED_PROVIDER</ulink></filename>_virtual/kernel (see below)</para></listitem>
1029 <listitem><para><filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-MACHINE_FEATURES'> 1036 <listitem><para><filename><ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE_FEATURES'>
1030 MACHINE_FEATURES</ulink></filename> (e.g. "kernel26 apm screen wifi")</para></listitem> 1037 MACHINE_FEATURES</ulink></filename> (e.g. "kernel26 apm screen wifi")</para></listitem>
1031 </itemizedlist> 1038 </itemizedlist>
1032 </para> 1039 </para>
@@ -1034,11 +1041,11 @@ so that there are some definite steps on how to do this. I need more detail her
1034 <para> 1041 <para>
1035 You might also need these variables: 1042 You might also need these variables:
1036 <itemizedlist> 1043 <itemizedlist>
1037 <listitem><para><filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-SERIAL_CONSOLE'> 1044 <listitem><para><filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SERIAL_CONSOLE'>
1038 SERIAL_CONSOLE</ulink></filename> (e.g. "115200 ttyS0")</para></listitem> 1045 SERIAL_CONSOLE</ulink></filename> (e.g. "115200 ttyS0")</para></listitem>
1039 <listitem><para><filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-KERNEL_IMAGETYPE'> 1046 <listitem><para><filename><ulink url='&YOCTO_DOCS_REF_URL;#var-KERNEL_IMAGETYPE'>
1040 KERNEL_IMAGETYPE</ulink></filename> (e.g. "zImage")</para></listitem> 1047 KERNEL_IMAGETYPE</ulink></filename> (e.g. "zImage")</para></listitem>
1041 <listitem><para><filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-IMAGE_FSTYPES'> 1048 <listitem><para><filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FSTYPES'>
1042 IMAGE_FSTYPES</ulink></filename> (e.g. "tar.gz jffs2")</para></listitem> 1049 IMAGE_FSTYPES</ulink></filename> (e.g. "tar.gz jffs2")</para></listitem>
1043 </itemizedlist> 1050 </itemizedlist>
1044 </para> 1051 </para>
@@ -1065,9 +1072,9 @@ so that there are some definite steps on how to do this. I need more detail her
1065 <para> 1072 <para>
1066 If you are creating a new recipe, normal recipe-writing rules apply for setting 1073 If you are creating a new recipe, normal recipe-writing rules apply for setting
1067 up a 1074 up a
1068 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-SRC_URI'>SRC_URI</ulink></filename>. 1075 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'>SRC_URI</ulink></filename>.
1069 Thus, you need to specify any necessary patches and set 1076 Thus, you need to specify any necessary patches and set
1070 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-S'>S</ulink></filename> to point at the source code. 1077 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-S'>S</ulink></filename> to point at the source code.
1071 You need to create a <filename>configure</filename> task that configures the 1078 You need to create a <filename>configure</filename> task that configures the
1072 unpacked kernel with a defconfig. 1079 unpacked kernel with a defconfig.
1073 You can do this by using a <filename>make defconfig</filename> command or, 1080 You can do this by using a <filename>make defconfig</filename> command or,
@@ -1085,7 +1092,7 @@ so that there are some definite steps on how to do this. I need more detail her
1085 used for other machines in a given kernel. 1092 used for other machines in a given kernel.
1086 A possible way to do this is by listing the file in the 1093 A possible way to do this is by listing the file in the
1087 <filename>SRC_URI</filename> and adding the machine to the expression in 1094 <filename>SRC_URI</filename> and adding the machine to the expression in
1088 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-COMPATIBLE_MACHINE'>COMPATIBLE_MACHINE</ulink></filename>: 1095 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-COMPATIBLE_MACHINE'>COMPATIBLE_MACHINE</ulink></filename>:
1089 <literallayout class='monospaced'> 1096 <literallayout class='monospaced'>
1090 COMPATIBLE_MACHINE = '(qemux86|qemumips)' 1097 COMPATIBLE_MACHINE = '(qemux86|qemumips)'
1091 </literallayout> 1098 </literallayout>
@@ -1159,7 +1166,7 @@ so that there are some definite steps on how to do this. I need more detail her
1159 During a build, the unpacked temporary source code used by recipes 1166 During a build, the unpacked temporary source code used by recipes
1160 to build packages is available in the Yocto Project Build Directory as 1167 to build packages is available in the Yocto Project Build Directory as
1161 defined by the 1168 defined by the
1162 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-S'>S</ulink></filename> variable. 1169 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-S'>S</ulink></filename> variable.
1163 Below is the default value for the <filename>S</filename> variable as defined in the 1170 Below is the default value for the <filename>S</filename> variable as defined in the
1164 <filename>meta/conf/bitbake.conf</filename> configuration file in the 1171 <filename>meta/conf/bitbake.conf</filename> configuration file in the
1165 <link linkend='yocto-project-files'>Yocto Project Files</link>: 1172 <link linkend='yocto-project-files'>Yocto Project Files</link>:
@@ -1180,7 +1187,7 @@ so that there are some definite steps on how to do this. I need more detail her
1180 1187
1181 <para> 1188 <para>
1182 The path to the work directory for the recipe 1189 The path to the work directory for the recipe
1183 (<ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-WORKDIR'><filename>WORKDIR</filename></ulink>) depends 1190 (<ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink>) depends
1184 on the package name and the architecture of the target device. 1191 on the package name and the architecture of the target device.
1185 For example, here is the work directory for packages whose targets are not device-dependent: 1192 For example, here is the work directory for packages whose targets are not device-dependent:
1186 <literallayout class='monospaced'> 1193 <literallayout class='monospaced'>
@@ -1212,15 +1219,15 @@ so that there are some definite steps on how to do this. I need more detail her
1212 <note> 1219 <note>
1213 To better understand how the Yocto Project build system resolves directories during the 1220 To better understand how the Yocto Project build system resolves directories during the
1214 build process, see the glossary entries for the 1221 build process, see the glossary entries for the
1215 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-WORKDIR'><filename>WORKDIR</filename></ulink>, 1222 <ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink>,
1216 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-TMPDIR'><filename>TMPDIR</filename></ulink>, 1223 <ulink url='&YOCTO_DOCS_REF_URL;#var-TMPDIR'><filename>TMPDIR</filename></ulink>,
1217 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-TOPDIR'><filename>TOPDIR</filename></ulink>, 1224 <ulink url='&YOCTO_DOCS_REF_URL;#var-TOPDIR'><filename>TOPDIR</filename></ulink>,
1218 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></ulink>, 1225 <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></ulink>,
1219 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-TARGET_OS'><filename>TARGET_OS</filename></ulink>, 1226 <ulink url='&YOCTO_DOCS_REF_URL;#var-TARGET_OS'><filename>TARGET_OS</filename></ulink>,
1220 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PN'><filename>PN</filename></ulink>, 1227 <ulink url='&YOCTO_DOCS_REF_URL;#var-PN'><filename>PN</filename></ulink>,
1221 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PV'><filename>PV</filename></ulink>, 1228 <ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink>,
1222 and 1229 and
1223 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PR'><filename>PR</filename></ulink> 1230 <ulink url='&YOCTO_DOCS_REF_URL;#var-PR'><filename>PR</filename></ulink>
1224 variables in the Yocto Project Reference Manual. 1231 variables in the Yocto Project Reference Manual.
1225 </note> 1232 </note>
1226 1233
@@ -1255,7 +1262,7 @@ so that there are some definite steps on how to do this. I need more detail her
1255 <listitem><para><emphasis>Change Your Working Directory:</emphasis> 1262 <listitem><para><emphasis>Change Your Working Directory:</emphasis>
1256 You need to be in the directory that has the temporary source code. 1263 You need to be in the directory that has the temporary source code.
1257 That directory is defined by the 1264 That directory is defined by the
1258 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-S'>S</ulink> 1265 <ulink url='&YOCTO_DOCS_REF_URL;#var-S'>S</ulink>
1259 variable.</para></listitem> 1266 variable.</para></listitem>
1260 <listitem><para><emphasis>Create a New Patch:</emphasis> 1267 <listitem><para><emphasis>Create a New Patch:</emphasis>
1261 Before modifying source code, you need to create a new patch. 1268 Before modifying source code, you need to create a new patch.
@@ -1287,7 +1294,7 @@ so that there are some definite steps on how to do this. I need more detail her
1287 <filename>-c cleanall</filename> with BitBake for the package. 1294 <filename>-c cleanall</filename> with BitBake for the package.
1288 Modifications will also disappear if you use the <filename>rm_work</filename> 1295 Modifications will also disappear if you use the <filename>rm_work</filename>
1289 feature as described in the 1296 feature as described in the
1290 "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#building-image'>Building an Image</ulink>" 1297 "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>"
1291 section of the Yocto Project Quick Start. 1298 section of the Yocto Project Quick Start.
1292 </note></para></listitem> 1299 </note></para></listitem>
1293 <listitem><para><emphasis>Generate the Patch:</emphasis> 1300 <listitem><para><emphasis>Generate the Patch:</emphasis>
@@ -1307,7 +1314,7 @@ so that there are some definite steps on how to do this. I need more detail her
1307 Placing the patch here guarantees that the Yocto Project build system will find 1314 Placing the patch here guarantees that the Yocto Project build system will find
1308 the patch. 1315 the patch.
1309 Next, add the patch into the 1316 Next, add the patch into the
1310 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-SRC_URI'>SRC_URI</ulink></filename> 1317 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'>SRC_URI</ulink></filename>
1311 of the recipe. 1318 of the recipe.
1312 Here is an example: 1319 Here is an example:
1313 <literallayout class='monospaced'> 1320 <literallayout class='monospaced'>
@@ -1315,7 +1322,7 @@ so that there are some definite steps on how to do this. I need more detail her
1315 </literallayout></para></listitem> 1322 </literallayout></para></listitem>
1316 <listitem><para><emphasis>Increment the Package Revision Number:</emphasis> 1323 <listitem><para><emphasis>Increment the Package Revision Number:</emphasis>
1317 Finally, don't forget to 'bump' the 1324 Finally, don't forget to 'bump' the
1318 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PR'>PR</ulink></filename> 1325 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PR'>PR</ulink></filename>
1319 value in the same recipe since the resulting packages have changed.</para></listitem> 1326 value in the same recipe since the resulting packages have changed.</para></listitem>
1320 </orderedlist> 1327 </orderedlist>
1321 </para> 1328 </para>
@@ -1351,7 +1358,7 @@ so that there are some definite steps on how to do this. I need more detail her
1351 <listitem><para><emphasis>Change Your Working Directory:</emphasis> 1358 <listitem><para><emphasis>Change Your Working Directory:</emphasis>
1352 You need to be in the directory that has the temporary source code. 1359 You need to be in the directory that has the temporary source code.
1353 That directory is defined by the 1360 That directory is defined by the
1354 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-S'>S</ulink> 1361 <ulink url='&YOCTO_DOCS_REF_URL;#var-S'>S</ulink>
1355 variable.</para></listitem> 1362 variable.</para></listitem>
1356 <listitem><para><emphasis>Initialize a Git Repository:</emphasis> 1363 <listitem><para><emphasis>Initialize a Git Repository:</emphasis>
1357 Use the <filename>git init</filename> command to initialize a new local repository 1364 Use the <filename>git init</filename> command to initialize a new local repository
@@ -1390,7 +1397,7 @@ so that there are some definite steps on how to do this. I need more detail her
1390 <filename>-c cleanall</filename> with BitBake for the package. 1397 <filename>-c cleanall</filename> with BitBake for the package.
1391 Modifications will also disappear if you use the <filename>rm_work</filename> 1398 Modifications will also disappear if you use the <filename>rm_work</filename>
1392 feature as described in the 1399 feature as described in the
1393 "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#building-image'>Building an Image</ulink>" 1400 "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>"
1394 section of the Yocto Project Quick Start. 1401 section of the Yocto Project Quick Start.
1395 </note></para></listitem> 1402 </note></para></listitem>
1396 <listitem><para><emphasis>See the List of Files You Changed:</emphasis> 1403 <listitem><para><emphasis>See the List of Files You Changed:</emphasis>
@@ -1435,7 +1442,7 @@ so that there are some definite steps on how to do this. I need more detail her
1435 Placing the patch here guarantees that the Yocto Project build system will find 1442 Placing the patch here guarantees that the Yocto Project build system will find
1436 the patch. 1443 the patch.
1437 Next, add the patch into the 1444 Next, add the patch into the
1438 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-SRC_URI'>SRC_URI</ulink></filename> 1445 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'>SRC_URI</ulink></filename>
1439 of the recipe. 1446 of the recipe.
1440 Here is an example: 1447 Here is an example:
1441 <literallayout class='monospaced'> 1448 <literallayout class='monospaced'>
@@ -1443,7 +1450,7 @@ so that there are some definite steps on how to do this. I need more detail her
1443 </literallayout></para></listitem> 1450 </literallayout></para></listitem>
1444 <listitem><para><emphasis>Increment the Package Revision Number:</emphasis> 1451 <listitem><para><emphasis>Increment the Package Revision Number:</emphasis>
1445 Finally, don't forget to 'bump' the 1452 Finally, don't forget to 'bump' the
1446 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PR'>PR</ulink></filename> 1453 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PR'>PR</ulink></filename>
1447 value in the same recipe since the resulting packages have changed.</para></listitem> 1454 value in the same recipe since the resulting packages have changed.</para></listitem>
1448 </orderedlist> 1455 </orderedlist>
1449 </para> 1456 </para>
@@ -1481,7 +1488,7 @@ so that there are some definite steps on how to do this. I need more detail her
1481 <para> 1488 <para>
1482 This section overviews the Multilib process only. 1489 This section overviews the Multilib process only.
1483 For more details on how to implement Multilib, see the 1490 For more details on how to implement Multilib, see the
1484 <ulink url='https://wiki.yoctoproject.org/wiki/Multilib'>Multilib</ulink> wiki 1491 <ulink url='&YOCTO_WIKI_URL;/wiki/Multilib'>Multilib</ulink> wiki
1485 page. 1492 page.
1486 </para> 1493 </para>
1487 1494
@@ -1630,7 +1637,7 @@ so that there are some definite steps on how to do this. I need more detail her
1630 1637
1631 <para> 1638 <para>
1632 For concepts on kernel configuration, see the 1639 For concepts on kernel configuration, see the
1633 "<ulink url='http://www.yoctoproject.org/docs/latest/kernel-manual/kernel-manual.html#kernel-configuration'>Kernel Configuration</ulink>" 1640 "<ulink url='&YOCTO_DOCS_KERNEL_URL;#kernel-configuration'>Kernel Configuration</ulink>"
1634 section in the Yocto Project Kernel Architecture and Use Manual. 1641 section in the Yocto Project Kernel Architecture and Use Manual.
1635 </para> 1642 </para>
1636 1643
@@ -1804,7 +1811,7 @@ so that there are some definite steps on how to do this. I need more detail her
1804 <para> 1811 <para>
1805 If a committed change results in changing the package output, 1812 If a committed change results in changing the package output,
1806 then the value of the 1813 then the value of the
1807 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PR'>PR</ulink></filename> 1814 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PR'>PR</ulink></filename>
1808 variable needs to be increased 1815 variable needs to be increased
1809 (or "bumped") as part of that commit. 1816 (or "bumped") as part of that commit.
1810 This means that for new recipes you must be sure to add the <filename>PR</filename> 1817 This means that for new recipes you must be sure to add the <filename>PR</filename>
@@ -1817,7 +1824,7 @@ so that there are some definite steps on how to do this. I need more detail her
1817 <para> 1824 <para>
1818 If you are sharing a common <filename>.inc</filename> file with multiple recipes, 1825 If you are sharing a common <filename>.inc</filename> file with multiple recipes,
1819 you can also use the 1826 you can also use the
1820 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-INC_PR'>INC_PR</ulink></filename> 1827 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-INC_PR'>INC_PR</ulink></filename>
1821 variable to ensure that 1828 variable to ensure that
1822 the recipes sharing the <filename>.inc</filename> file are rebuilt when the 1829 the recipes sharing the <filename>.inc</filename> file are rebuilt when the
1823 <filename>.inc</filename> file itself is changed. 1830 <filename>.inc</filename> file itself is changed.
@@ -1830,7 +1837,7 @@ so that there are some definite steps on how to do this. I need more detail her
1830 1837
1831 <para> 1838 <para>
1832 When upgrading the version of a package, assuming the 1839 When upgrading the version of a package, assuming the
1833 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PV'>PV</ulink></filename> 1840 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PV'>PV</ulink></filename>
1834 changes, the <filename>PR</filename> variable should be reset to "r0" 1841 changes, the <filename>PR</filename> variable should be reset to "r0"
1835 (or "$(INC_PR).0" if you are using <filename>INC_PR</filename>). 1842 (or "$(INC_PR).0" if you are using <filename>INC_PR</filename>).
1836 </para> 1843 </para>
@@ -1839,7 +1846,7 @@ so that there are some definite steps on how to do this. I need more detail her
1839 Usually, version increases occur only to packages. 1846 Usually, version increases occur only to packages.
1840 However, if for some reason <filename>PV</filename> changes but does not 1847 However, if for some reason <filename>PV</filename> changes but does not
1841 increase, you can increase the 1848 increase, you can increase the
1842 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PE'>PE</ulink></filename> 1849 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PE'>PE</ulink></filename>
1843 variable (Package Epoch). 1850 variable (Package Epoch).
1844 The <filename>PE</filename> variable defaults to "0". 1851 The <filename>PE</filename> variable defaults to "0".
1845 </para> 1852 </para>
@@ -1876,7 +1883,7 @@ so that there are some definite steps on how to do this. I need more detail her
1876 If the package exists under a different name in a different distribution, you get a 1883 If the package exists under a different name in a different distribution, you get a
1877 <filename>distro_check</filename> mismatch. 1884 <filename>distro_check</filename> mismatch.
1878 You can resolve this problem by defining a per-distro recipe name alias using the 1885 You can resolve this problem by defining a per-distro recipe name alias using the
1879 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-DISTRO_PN_ALIAS'>DISTRO_PN_ALIAS</ulink></filename> 1886 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_PN_ALIAS'>DISTRO_PN_ALIAS</ulink></filename>
1880 variable. 1887 variable.
1881 </para> 1888 </para>
1882 1889
@@ -1928,16 +1935,16 @@ so that there are some definite steps on how to do this. I need more detail her
1928 In this case, you want a kernel source directory on the development machine where the 1935 In this case, you want a kernel source directory on the development machine where the
1929 development occurs. 1936 development occurs.
1930 You want the recipe's 1937 You want the recipe's
1931 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-SRC_URI'><filename>SRC_URI</filename></ulink> 1938 <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink>
1932 variable to point to the external directory and use it as is, not copy it. 1939 variable to point to the external directory and use it as is, not copy it.
1933 </para> 1940 </para>
1934 1941
1935 <para> 1942 <para>
1936 To build from software that comes from an external source, all you need to do is 1943 To build from software that comes from an external source, all you need to do is
1937 change your recipe so that it inherits the 1944 change your recipe so that it inherits the
1938 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#ref-classes-externalsrc'><filename>externalsrc.bbclass</filename></ulink> 1945 <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-externalsrc'><filename>externalsrc.bbclass</filename></ulink>
1939 class and then sets the 1946 class and then sets the
1940 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-S'><filename>S</filename></ulink> 1947 <ulink url='&YOCTO_DOCS_REF_URL;#var-S'><filename>S</filename></ulink>
1941 variable to point to your external source code. 1948 variable to point to your external source code.
1942 Here are the statements to put in your recipe: 1949 Here are the statements to put in your recipe:
1943 <literallayout class='monospaced'> 1950 <literallayout class='monospaced'>
@@ -1949,11 +1956,11 @@ so that there are some definite steps on how to do this. I need more detail her
1949 <para> 1956 <para>
1950 It is important to know that the <filename>externalsrc.bbclass</filename> assumes that the 1957 It is important to know that the <filename>externalsrc.bbclass</filename> assumes that the
1951 source directory <filename>S</filename> and the build directory 1958 source directory <filename>S</filename> and the build directory
1952 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-B'><filename>B</filename></ulink> 1959 <ulink url='&YOCTO_DOCS_REF_URL;#var-B'><filename>B</filename></ulink>
1953 are different even though by default these directories are the same. 1960 are different even though by default these directories are the same.
1954 This assumption is important because it supports building different variants of the recipe 1961 This assumption is important because it supports building different variants of the recipe
1955 by using the 1962 by using the
1956 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual#var-BBCLASSEXTEND'><filename>BBCLASSEXTEND</filename></ulink> 1963 <ulink url='&YOCTO_DOCS_REF_URL;#var-BBCLASSEXTEND'><filename>BBCLASSEXTEND</filename></ulink>
1957 variable. 1964 variable.
1958 You could allow the build directory to be the same as the source directory but you would 1965 You could allow the build directory to be the same as the source directory but you would
1959 not be able to build more than one variant of the recipe. 1966 not be able to build more than one variant of the recipe.
diff --git a/documentation/dev-manual/dev-manual-intro.xml b/documentation/dev-manual/dev-manual-intro.xml
index b70d384749..02769fb84b 100644
--- a/documentation/dev-manual/dev-manual-intro.xml
+++ b/documentation/dev-manual/dev-manual-intro.xml
@@ -1,5 +1,6 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
3 4
4<chapter id='dev-manual-intro'> 5<chapter id='dev-manual-intro'>
5 6
@@ -69,7 +70,7 @@
69 <listitem><para>Reference material. 70 <listitem><para>Reference material.
70 This type of material resides in an appropriate reference manual. 71 This type of material resides in an appropriate reference manual.
71 For example, system variables are documented in the 72 For example, system variables are documented in the
72 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html'> 73 <ulink url='&YOCTO_DOCS_REF_URL;'>
73 Yocto Project Reference Manual</ulink>.</para></listitem> 74 Yocto Project Reference Manual</ulink>.</para></listitem>
74 <listitem><para>Detailed public information that is not specific to the Yocto Project. 75 <listitem><para>Detailed public information that is not specific to the Yocto Project.
75 For example, exhaustive information on how to use Git is covered better through the 76 For example, exhaustive information on how to use Git is covered better through the
@@ -86,31 +87,31 @@
86 need to supplement it with other information. 87 need to supplement it with other information.
87 The following list presents other sources of information you might find helpful: 88 The following list presents other sources of information you might find helpful:
88 <itemizedlist> 89 <itemizedlist>
89 <listitem><para><emphasis>The <ulink url='http://www.yoctoproject.org'>Yocto Project Website</ulink>: 90 <listitem><para><emphasis>The <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>:
90 </emphasis> The home page for the Yocto Project provides lots of information on the project 91 </emphasis> The home page for the Yocto Project provides lots of information on the project
91 as well as links to software and documentation.</para></listitem> 92 as well as links to software and documentation.</para></listitem>
92 <listitem><para><emphasis> 93 <listitem><para><emphasis>
93 <ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html'> 94 <ulink url='&YOCTO_DOCS_QS_URL;'>
94 The Yocto Project Quick Start</ulink>:</emphasis> This short document lets you get started 95 The Yocto Project Quick Start</ulink>:</emphasis> This short document lets you get started
95 with the Yocto Project quickly and start building an image.</para></listitem> 96 with the Yocto Project quickly and start building an image.</para></listitem>
96 <listitem><para><emphasis> 97 <listitem><para><emphasis>
97 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html'> 98 <ulink url='&YOCTO_DOCS_REF_URL;'>
98 The Yocto Project Reference Manual</ulink>:</emphasis> This manual is a reference 99 The Yocto Project Reference Manual</ulink>:</emphasis> This manual is a reference
99 guide to the Yocto Project build component known as "Poky." 100 guide to the Yocto Project build component known as "Poky."
100 The manual also contains a reference chapter on Board Support Package (BSP) 101 The manual also contains a reference chapter on Board Support Package (BSP)
101 layout.</para></listitem> 102 layout.</para></listitem>
102 <listitem><para><emphasis> 103 <listitem><para><emphasis>
103 <ulink url='http://www.yoctoproject.org/docs/latest/adt-manual/adt-manual.html'> 104 <ulink url='&YOCTO_DOCS_ADT_URL;'>
104 The Yocto Project Application Development Toolkit (ADT) User's Guide</ulink>:</emphasis> 105 The Yocto Project Application Development Toolkit (ADT) User's Guide</ulink>:</emphasis>
105 This guide provides information that lets you get going with the ADT to 106 This guide provides information that lets you get going with the ADT to
106 develop projects using the Yocto Project.</para></listitem> 107 develop projects using the Yocto Project.</para></listitem>
107 <listitem><para><emphasis> 108 <listitem><para><emphasis>
108 <ulink url='http://www.yoctoproject.org/docs/latest/bsp-guide/bsp-guide.html'> 109 <ulink url='&YOCTO_DOCS_BSP_URL;'>
109 The Yocto Project Board Support Package (BSP) Developer's Guide</ulink>:</emphasis> 110 The Yocto Project Board Support Package (BSP) Developer's Guide</ulink>:</emphasis>
110 This guide defines the structure for BSP components. 111 This guide defines the structure for BSP components.
111 Having a commonly understood structure encourages standardization.</para></listitem> 112 Having a commonly understood structure encourages standardization.</para></listitem>
112 <listitem><para><emphasis> 113 <listitem><para><emphasis>
113 <ulink url='http://www.yoctoproject.org/docs/latest/kernel-manual/kernel-manual.html'> 114 <ulink url='&YOCTO_DOCS_KERNEL_URL;'>
114 The Yocto Project Kernel Architecture and Use Manual</ulink>:</emphasis> 115 The Yocto Project Kernel Architecture and Use Manual</ulink>:</emphasis>
115 This manual describes the architecture of the Yocto Project kernel and provides 116 This manual describes the architecture of the Yocto Project kernel and provides
116 some work flow examples.</para></listitem> 117 some work flow examples.</para></listitem>
@@ -120,14 +121,14 @@
120 demonstrates how an application developer uses Yocto Plug-in features within 121 demonstrates how an application developer uses Yocto Plug-in features within
121 the Eclipse IDE.</para></listitem> 122 the Eclipse IDE.</para></listitem>
122 <listitem><para><emphasis> 123 <listitem><para><emphasis>
123 <ulink url='http://wiki.yoctoproject.org/wiki/FAQ'>FAQ</ulink>:</emphasis> 124 <ulink url='&YOCTO_WIKI_URL;/wiki/FAQ'>FAQ</ulink>:</emphasis>
124 A list of commonly asked questions and their answers.</para></listitem> 125 A list of commonly asked questions and their answers.</para></listitem>
125 <listitem><para><emphasis> 126 <listitem><para><emphasis>
126 <ulink url='http://www.yoctoproject.org/download/yocto/yocto-project-1.1-release-notes-poky-6.0'> 127 <ulink url='&YOCTO_HOME_URL;/download/yocto/yocto-project-1.1-release-notes-poky-&POKYVERSION;'>
127 Release Notes</ulink>:</emphasis> Features, updates and known issues for the current 128 Release Notes</ulink>:</emphasis> Features, updates and known issues for the current
128 release of the Yocto Project.</para></listitem> 129 release of the Yocto Project.</para></listitem>
129 <listitem><para><emphasis> 130 <listitem><para><emphasis>
130 <ulink url='http://bugzilla.yoctoproject.org/'>Bugzilla</ulink>:</emphasis> 131 <ulink url='&YOCTO_BUGZILLA_URL;'>Bugzilla</ulink>:</emphasis>
131 The bug tracking application the Yocto Project uses. 132 The bug tracking application the Yocto Project uses.
132 If you find problems with the Yocto Project, you should report them using this 133 If you find problems with the Yocto Project, you should report them using this
133 application.</para></listitem> 134 application.</para></listitem>
@@ -135,11 +136,11 @@
135 Yocto Project Mailing Lists:</emphasis> To subscribe to the Yocto Project mailing 136 Yocto Project Mailing Lists:</emphasis> To subscribe to the Yocto Project mailing
136 lists, click on the following URLs and follow the instructions: 137 lists, click on the following URLs and follow the instructions:
137 <itemizedlist> 138 <itemizedlist>
138 <listitem><para><ulink url='http://lists.yoctoproject.org/listinfo/yocto'></ulink> for a 139 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto'></ulink> for a
139 Yocto Project Discussions mailing list.</para></listitem> 140 Yocto Project Discussions mailing list.</para></listitem>
140 <listitem><para><ulink url='http://lists.yoctoproject.org/listinfo/poky'></ulink> for a 141 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/poky'></ulink> for a
141 Yocto Project Discussions mailing list about the Poky build system.</para></listitem> 142 Yocto Project Discussions mailing list about the Poky build system.</para></listitem>
142 <listitem><para><ulink url='http://lists.yoctoproject.org/listinfo/yocto-announce'></ulink> 143 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto-announce'></ulink>
143 for a mailing list to receive offical Yocto Project announcements for developments and 144 for a mailing list to receive offical Yocto Project announcements for developments and
144 as well as Yocto Project milestones.</para></listitem> 145 as well as Yocto Project milestones.</para></listitem>
145 </itemizedlist></para></listitem> 146 </itemizedlist></para></listitem>
@@ -148,7 +149,7 @@
148 for Yocto Project and Poky discussions: <filename>#yocto</filename> and 149 for Yocto Project and Poky discussions: <filename>#yocto</filename> and
149 <filename>#poky</filename>.</para></listitem> 150 <filename>#poky</filename>.</para></listitem>
150 <listitem><para><emphasis> 151 <listitem><para><emphasis>
151 <ulink url='http://www.openedhand.com/'>OpenedHand</ulink>:</emphasis> 152 <ulink url='&OH_HOME_URL;'>OpenedHand</ulink>:</emphasis>
152 The company where the Yocto Project build system Poky was first developed. 153 The company where the Yocto Project build system Poky was first developed.
153 OpenedHand has since been acquired by Intel Corporation.</para></listitem> 154 OpenedHand has since been acquired by Intel Corporation.</para></listitem>
154 <listitem><para><emphasis> 155 <listitem><para><emphasis>
@@ -156,7 +157,7 @@
156 The company that acquired OpenedHand in 2008 and continues development on the 157 The company that acquired OpenedHand in 2008 and continues development on the
157 Yocto Project.</para></listitem> 158 Yocto Project.</para></listitem>
158 <listitem><para><emphasis> 159 <listitem><para><emphasis>
159 <ulink url='http://www.openembedded.org/'>OpenEmbedded</ulink>:</emphasis> 160 <ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>:</emphasis>
160 The upstream, generic, embedded distribution the Yocto Project build system (Poky) derives 161 The upstream, generic, embedded distribution the Yocto Project build system (Poky) derives
161 from and to which it contributes.</para></listitem> 162 from and to which it contributes.</para></listitem>
162 <listitem><para><emphasis> 163 <listitem><para><emphasis>
diff --git a/documentation/dev-manual/dev-manual-kernel-appendix.xml b/documentation/dev-manual/dev-manual-kernel-appendix.xml
index 0836fe9335..58f33e8ef3 100644
--- a/documentation/dev-manual/dev-manual-kernel-appendix.xml
+++ b/documentation/dev-manual/dev-manual-kernel-appendix.xml
@@ -1,5 +1,6 @@
1<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 1<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
3 4
4<appendix id='dev-manual-kernel-appendix'> 5<appendix id='dev-manual-kernel-appendix'>
5 6
@@ -43,10 +44,15 @@
43 structures you need. 44 structures you need.
44 Briefly, you need the following: 45 Briefly, you need the following:
45 <itemizedlist> 46 <itemizedlist>
46 <listitem><para>A local Yocto Project files Git repository</para></listitem> 47 <listitem><para>A local
47 <listitem><para>The <filename>poky-extras</filename> Git repository placed 48 <link linkend='yocto-project-files'>Yocto Project Files</link>
48 within the local Yocto Project files Git repository</para></listitem> 49 Git repository</para></listitem>
49 <listitem><para>A bare clone of the Linux Yocto kernel upstream Git 50 <listitem><para>The
51 <link linkend='poky-extras-repo'><filename>poky-extras</filename></link>
52 Git repository placed within the local Yocto Project files Git
53 repository</para></listitem>
54 <listitem><para>A bare clone of the
55 <link linkend='local-kernel-files'>Linux Yocto Kernel</link> upstream Git
50 repository to which you want to push your modifications. 56 repository to which you want to push your modifications.
51 </para></listitem> 57 </para></listitem>
52 <listitem><para>A copy of that bare clone in which you make your source 58 <listitem><para>A copy of that bare clone in which you make your source
@@ -154,9 +160,9 @@
154 The following commands create and checkout the local <filename>edison</filename> 160 The following commands create and checkout the local <filename>edison</filename>
155 branch: 161 branch:
156 <literallayout class='monospaced'> 162 <literallayout class='monospaced'>
157 $ git checkout -b edison origin/edison 163 $ git checkout -b &DISTRO_NAME; origin/&DISTRO_NAME;
158 Branch edison set up to track remote branch edison from origin. 164 Branch edison set up to track remote branch &DISTRO_NAME; from origin.
159 Switched to a new branch 'edison' 165 Switched to a new branch '&DISTRO_NAME;'
160 </literallayout> 166 </literallayout>
161 </para> 167 </para>
162 </section> 168 </section>
@@ -539,14 +545,14 @@
539 $ git branch -a 545 $ git branch -a
540 $ git tag -l 546 $ git tag -l
541 </literallayout> 547 </literallayout>
542 This example uses the Yocto Project 1.1.1 Release code named "edison", 548 This example uses the Yocto Project 1.1.1 Release code named "&DISTRO_NAME;",
543 which maps to the <filename>edison</filename> branch in the repository. 549 which maps to the <filename>&DISTRO_NAME;</filename> branch in the repository.
544 The following commands create and checkout the local <filename>edison</filename> 550 The following commands create and checkout the local <filename>&DISTRO_NAME;</filename>
545 branch: 551 branch:
546 <literallayout class='monospaced'> 552 <literallayout class='monospaced'>
547 $ git checkout -b edison origin/edison 553 $ git checkout -b &DISTRO_NAME; origin/&DISTRO_NAME;
548 Branch edison set up to track remote branch edison from origin. 554 Branch edison set up to track remote branch &DISTRO_NAME; from origin.
549 Switched to a new branch 'edison' 555 Switched to a new branch '&DISTRO_NAME;'
550 </literallayout> 556 </literallayout>
551 </para> 557 </para>
552 558
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml
index 9be8673244..46adc97863 100644
--- a/documentation/dev-manual/dev-manual-model.xml
+++ b/documentation/dev-manual/dev-manual-model.xml
@@ -1,5 +1,6 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
3 4
4<chapter id='dev-manual-model'> 5<chapter id='dev-manual-model'>
5 6
@@ -24,7 +25,7 @@
24 For a user-space application development example that uses the 25 For a user-space application development example that uses the
25 <trademark class='trade'>Eclipse</trademark> IDE, 26 <trademark class='trade'>Eclipse</trademark> IDE,
26 see the 27 see the
27 <ulink url='http://www.yoctoproject.org/docs/latest/adt-manual/adt-manual.html'> 28 <ulink url='&YOCTO_DOCS_ADT_URL;'>
28 The Yocto Project Application Development Toolkit (ADT) User's Guide</ulink>. 29 The Yocto Project Application Development Toolkit (ADT) User's Guide</ulink>.
29</para> 30</para>
30 31
@@ -79,8 +80,9 @@
79 <orderedlist> 80 <orderedlist>
80 <listitem><para><emphasis>Set up your host development system to support 81 <listitem><para><emphasis>Set up your host development system to support
81 development using the Yocto Project</emphasis>: See the 82 development using the Yocto Project</emphasis>: See the
82 "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#the-linux-distro'>The Linux Distributions</ulink>" and the 83 "<ulink url='&YOCTO_DOCS_QS_URL;#the-linux-distro'>The Linux Distributions</ulink>"
83 "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#packages'>The Packages</ulink>" sections both 84 and the
85 "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" sections both
84 in the Yocto Project Quick Start for requirements.</para></listitem> 86 in the Yocto Project Quick Start for requirements.</para></listitem>
85 <listitem><para><emphasis>Establish a local copy of the Yocto Project files on your 87 <listitem><para><emphasis>Establish a local copy of the Yocto Project files on your
86 system</emphasis>: You need to have the Yocto Project files available on your host system. 88 system</emphasis>: You need to have the Yocto Project files available on your host system.
@@ -112,7 +114,7 @@
112 Embedded Media Graphics Driver (EMGD). 114 Embedded Media Graphics Driver (EMGD).
113 The remainder of this example uses that base BSP.</para> 115 The remainder of this example uses that base BSP.</para>
114 <para>To see the supported BSPs, go to the Yocto Project 116 <para>To see the supported BSPs, go to the Yocto Project
115 <ulink url='http://www.yoctoproject.org/download'>download page</ulink> and click 117 <ulink url='&YOCTO_DL_URL;/download'>download page</ulink> and click
116 on “BSP Downloads.”</para></listitem> 118 on “BSP Downloads.”</para></listitem>
117 <listitem><para><emphasis>Create your own BSP layer</emphasis>: Layers are ideal for 119 <listitem><para><emphasis>Create your own BSP layer</emphasis>: Layers are ideal for
118 isolating and storing work for a given piece of hardware. 120 isolating and storing work for a given piece of hardware.
@@ -137,16 +139,17 @@
137 N450, and Sugar Bay are isolated.</note> 139 N450, and Sugar Bay are isolated.</note>
138 <para>When you set up a layer for a new BSP, you should follow a standard layout. 140 <para>When you set up a layer for a new BSP, you should follow a standard layout.
139 This layout is described in the section 141 This layout is described in the section
140 "<ulink url='http://www.yoctoproject.org/docs/latest/bsp-guide/bsp-guide.html#bsp-filelayout'>Example Filesystem Layout</ulink>" section of the Board Support Package (BSP) Development Guide. 142 "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-filelayout'>Example Filesystem Layout</ulink>"
143 section of the Board Support Package (BSP) Development Guide.
141 In the standard layout, you will notice a suggested structure for recipes and 144 In the standard layout, you will notice a suggested structure for recipes and
142 configuration information. 145 configuration information.
143 You can see the standard layout for the Crown Bay BSP in this example by examining the 146 You can see the standard layout for the Crown Bay BSP in this example by examining the
144 directory structure of the <filename>meta-crownbay</filename> layer inside the 147 directory structure of the <filename>meta-crownbay</filename> layer inside the
145 local Yocto Project files.</para></listitem> 148 local Yocto Project files.</para></listitem>
146 <listitem><para><emphasis>Make configuration changes to your new BSP 149 <listitem><para><emphasis>Make configuration changes to your new BSP
147 layer</emphasis>: The standard BSP layer structure organizes the files you need to edit in 150 layer</emphasis>: The standard BSP layer structure organizes the files you need
148 <filename>conf</filename> and several <filename>recipes-*</filename> directories within the 151 to edit in <filename>conf</filename> and several <filename>recipes-*</filename>
149 BSP layer. 152 directories within the BSP layer.
150 Configuration changes identify where your new layer is on the local system 153 Configuration changes identify where your new layer is on the local system
151 and identify which kernel you are going to use. 154 and identify which kernel you are going to use.
152 </para></listitem> 155 </para></listitem>
@@ -160,7 +163,8 @@
160 You need to get the build environment ready by sourcing an environment setup script 163 You need to get the build environment ready by sourcing an environment setup script
161 and you need to be sure two key configuration files are configured appropriately.</para> 164 and you need to be sure two key configuration files are configured appropriately.</para>
162 <para>The entire process for building an image is overviewed in the section 165 <para>The entire process for building an image is overviewed in the section
163 "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#building-image'>Building an Image</ulink>" section of the Yocto Project Quick Start. 166 "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" section
167 of the Yocto Project Quick Start.
164 You might want to reference this information.</para></listitem> 168 You might want to reference this information.</para></listitem>
165 <listitem><para><emphasis>Build the image</emphasis>: The Yocto Project uses the BitBake 169 <listitem><para><emphasis>Build the image</emphasis>: The Yocto Project uses the BitBake
166 tool to build images based on the type of image you want to create. 170 tool to build images based on the type of image you want to create.
@@ -168,7 +172,7 @@
168 <ulink url='http://bitbake.berlios.de/manual/'>here</ulink>.</para> 172 <ulink url='http://bitbake.berlios.de/manual/'>here</ulink>.</para>
169 <para>The build process supports several types of images to satisfy different needs. 173 <para>The build process supports several types of images to satisfy different needs.
170 See the 174 See the
171 "<ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#ref-images'>Reference: Images</ulink>" appendix 175 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink>" appendix
172 in The Yocto Project Reference Manual for information on 176 in The Yocto Project Reference Manual for information on
173 supported images.</para></listitem> 177 supported images.</para></listitem>
174 </orderedlist> 178 </orderedlist>
@@ -178,10 +182,10 @@
178 You can view a video presentation on "Building Custom Embedded Images with Yocto" 182 You can view a video presentation on "Building Custom Embedded Images with Yocto"
179 at <ulink url='http://free-electrons.com/blog/elc-2011-videos'>Free Electrons</ulink>. 183 at <ulink url='http://free-electrons.com/blog/elc-2011-videos'>Free Electrons</ulink>.
180 You can also find supplemental information in 184 You can also find supplemental information in
181 <ulink url='http://yoctoproject.org/docs/latest/bsp-guide/bsp-guide.html'> 185 <ulink url='&YOCTO_DOCS_BSP_URL;'>
182 The Board Support Package (BSP) Development Guide</ulink>. 186 The Board Support Package (BSP) Development Guide</ulink>.
183 Finally, there is wiki page write up of the example also located 187 Finally, there is wiki page write up of the example also located
184 <ulink url='https://wiki.yoctoproject.org/wiki/Transcript:_creating_one_generic_Atom_BSP_from_another'> 188 <ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_creating_one_generic_Atom_BSP_from_another'>
185 here</ulink> that you might find helpful. 189 here</ulink> that you might find helpful.
186 </para> 190 </para>
187 </section> 191 </section>
@@ -201,7 +205,7 @@
201 The remainder of this section presents a high-level overview of the Linux Yocto 205 The remainder of this section presents a high-level overview of the Linux Yocto
202 kernel architecture and the steps to modify the Linux Yocto kernel. 206 kernel architecture and the steps to modify the Linux Yocto kernel.
203 For a complete discussion of the kernel, see 207 For a complete discussion of the kernel, see
204 <ulink url='http://www.yoctoproject.org/docs/latest/kernel-manual/kernel-manual.html'> 208 <ulink url='&YOCTO_DOCS_KERNEL_URL;'>
205 The Yocto Project Kernel Architecture and Use Manual</ulink>. 209 The Yocto Project Kernel Architecture and Use Manual</ulink>.
206 You can reference the appendix 210 You can reference the appendix
207 "<link linkend='dev-manual-kernel-appendix'>Kernel Modification Example</link>" 211 "<link linkend='dev-manual-kernel-appendix'>Kernel Modification Example</link>"
@@ -221,7 +225,7 @@
221 225
222 <para> 226 <para>
223 You can find a web interface to the Linux Yocto kernel source repositories at 227 You can find a web interface to the Linux Yocto kernel source repositories at
224 <ulink url='http://git.yoctoproject.org/'></ulink>. 228 <ulink url='&YOCTO_GIT_URL;'></ulink>.
225 If you look at the interface, you will see to the left a grouping of 229 If you look at the interface, you will see to the left a grouping of
226 Git repositories titled "Yocto Linux Kernel." 230 Git repositories titled "Yocto Linux Kernel."
227 Within this group, you will find the four different kernels supported by 231 Within this group, you will find the four different kernels supported by
@@ -352,7 +356,7 @@
352 <para> 356 <para>
353 Again, for a complete discussion of the Yocto Project kernel's architcture and its 357 Again, for a complete discussion of the Yocto Project kernel's architcture and its
354 branching strategy, 358 branching strategy,
355 see the <ulink url='http://www.yoctoproject.org/docs/latest/kernel-manual/kernel-manual.html'> 359 see the <ulink url='&YOCTO_DOCS_KERNEL_URL;'>
356 The Yocto Project Kernel Architecture and Use Manual</ulink>. 360 The Yocto Project Kernel Architecture and Use Manual</ulink>.
357 Also, you can reference 361 Also, you can reference
358 <xref linkend='modifying-the-kernel-source-code'>Modifying the Kernel Source Code</xref> 362 <xref linkend='modifying-the-kernel-source-code'>Modifying the Kernel Source Code</xref>
@@ -376,8 +380,8 @@
376 <orderedlist> 380 <orderedlist>
377 <listitem><para><emphasis>Set up your host development system to support 381 <listitem><para><emphasis>Set up your host development system to support
378 development using the Yocto Project</emphasis>: See 382 development using the Yocto Project</emphasis>: See
379 "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#the-linux-distro'>The Linux Distributions</ulink>" and 383 "<ulink url='&YOCTO_DOCS_QS_URL;#the-linux-distro'>The Linux Distributions</ulink>" and
380 "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#packages'>The Packages</ulink>" sections both 384 "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" sections both
381 in the Yocto Project Quick Start for requirements.</para></listitem> 385 in the Yocto Project Quick Start for requirements.</para></listitem>
382 <listitem><para><emphasis>Establish a local copy of the Yocto Project files on your 386 <listitem><para><emphasis>Establish a local copy of the Yocto Project files on your
383 system</emphasis>: Having the Yocto Project files on your system gives you access to 387 system</emphasis>: Having the Yocto Project files on your system gives you access to
@@ -457,7 +461,8 @@
457 (<filename>local.conf</filename> and <filename>bblayers.conf</filename>) 461 (<filename>local.conf</filename> and <filename>bblayers.conf</filename>)
458 are configured appropriately.</para> 462 are configured appropriately.</para>
459 <para>The entire process for building an image is overviewed in the 463 <para>The entire process for building an image is overviewed in the
460 "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#building-image'>Building an Image</ulink>" section of the Yocto Project Quick Start. 464 "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>"
465 section of the Yocto Project Quick Start.
461 You might want to reference this information. 466 You might want to reference this information.
462 Also, you should look at the detailed examples found in the appendices at 467 Also, you should look at the detailed examples found in the appendices at
463 at the end of this manual.</para></listitem> 468 at the end of this manual.</para></listitem>
@@ -468,7 +473,7 @@
468 <ulink url='http://bitbake.berlios.de/manual/'>here</ulink>.</para> 473 <ulink url='http://bitbake.berlios.de/manual/'>here</ulink>.</para>
469 <para>The build process supports several types of images to satisfy different needs. 474 <para>The build process supports several types of images to satisfy different needs.
470 See the appendix 475 See the appendix
471 "<ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#ref-images'>Reference: Images</ulink>" in 476 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink>" in
472 The Yocto Project Reference Manual for information on supported images.</para></listitem> 477 The Yocto Project Reference Manual for information on supported images.</para></listitem>
473 <listitem><para><emphasis>Make your configuration changes available 478 <listitem><para><emphasis>Make your configuration changes available
474 in the kernel layer</emphasis>: Up to this point, all the configuration changes to the 479 in the kernel layer</emphasis>: Up to this point, all the configuration changes to the
@@ -519,7 +524,7 @@
519 provides an overview of the general development process. 524 provides an overview of the general development process.
520 If you want to see a detailed example of the process as it is used from within the Eclipse 525 If you want to see a detailed example of the process as it is used from within the Eclipse
521 IDE, see 526 IDE, see
522 <ulink url='http://www.yoctoproject.org/docs/latest/adt-manual/adt-manual.html'> 527 <ulink url='&YOCTO_DOCS_ADT_URL;'>
523 The Application Development Toolkit (ADT) User's Manual</ulink>. 528 The Application Development Toolkit (ADT) User's Manual</ulink>.
524 </para> 529 </para>
525 530
@@ -536,8 +541,8 @@
536 <orderedlist> 541 <orderedlist>
537 <listitem><para><emphasis>Prepare the Host System for the Yocto Project</emphasis>: 542 <listitem><para><emphasis>Prepare the Host System for the Yocto Project</emphasis>:
538 See 543 See
539 "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#the-linux-distro'>The Linux Distributions</ulink>" and 544 "<ulink url='&YOCTO_DOCS_QS_URL;#the-linux-distro'>The Linux Distributions</ulink>" and
540 "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#packages'>The Packages</ulink>" sections both 545 "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" sections both
541 in the Yocto Project Quick Start for requirements.</para></listitem> 546 in the Yocto Project Quick Start for requirements.</para></listitem>
542 547
543<!-- 548<!--
@@ -565,12 +570,12 @@ WRITER NOTE: The areas to get the kernel and root filesystem are located in the
565 (QEMU or real hardware), the area you get the image from differs. 570 (QEMU or real hardware), the area you get the image from differs.
566 <itemizedlist> 571 <itemizedlist>
567 <listitem><para>Download the image from 572 <listitem><para>Download the image from
568 <ulink url='http://www.yoctoproject.org/downloads/yocto-1.1/machines/'> 573 <ulink url='&YOCTO_MACHINES_DL_URL;'>
569 <filename>machines</filename></ulink> if your target architecture is supported 574 <filename>machines</filename></ulink> if your target architecture is supported
570 and you are going to develop and test your application on actual hardware. 575 and you are going to develop and test your application on actual hardware.
571 </para></listitem> 576 </para></listitem>
572 <listitem><para>Download the image from the 577 <listitem><para>Download the image from the
573 <ulink url='http://www.yoctoproject.org/downloads/yocto-1.1/machines/qemu/'> 578 <ulink url='&YOCTO_QEMU_DL_URL;'>
574 <filename>machines/qemu</filename></ulink> if your target architecture is supported 579 <filename>machines/qemu</filename></ulink> if your target architecture is supported
575 and you are going to develop and test your application using the QEMU 580 and you are going to develop and test your application using the QEMU
576 emulator.</para></listitem> 581 emulator.</para></listitem>
@@ -585,10 +590,8 @@ WRITER NOTE: The areas to get the kernel and root filesystem are located in the
585 </itemizedlist></para> 590 </itemizedlist></para>
586 <para>For information on pre-built kernel image naming schemes for images 591 <para>For information on pre-built kernel image naming schemes for images
587 that can run on the QEMU emulator, see the 592 that can run on the QEMU emulator, see the
588 "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#using-pre-built'>Using Pre-Built Binaries and QEMU</ulink>" 593 "<ulink url='&YOCTO_DOCS_QS_URL;#using-pre-built'>Using Pre-Built Binaries and QEMU</ulink>"
589 section in 594 section in the Yocto Project Quick Start.</para></listitem>
590 <ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html'>
591 The Yocto Project Quick Start</ulink>.</para></listitem>
592 <listitem><para><emphasis>Install the ADT</emphasis>: 595 <listitem><para><emphasis>Install the ADT</emphasis>:
593 The ADT provides a target-specific cross-development toolchain, the root filesystem, 596 The ADT provides a target-specific cross-development toolchain, the root filesystem,
594 the QEMU emulator, and other tools that can help you develop your application. 597 the QEMU emulator, and other tools that can help you develop your application.
@@ -596,8 +599,9 @@ WRITER NOTE: The areas to get the kernel and root filesystem are located in the
596 easy method. 599 easy method.
597 You can get these pieces by running an ADT installer script, which is configurable. 600 You can get these pieces by running an ADT installer script, which is configurable.
598 For information on how to install the ADT, see the 601 For information on how to install the ADT, see the
599 "<ulink url='http://www.yoctoproject.org/docs/latest/adt-manual/adt-manual.html#using-the-adt-installer'>Using the ADT Installer</ulink>" section 602 "<ulink url='&YOCTO_DOCS_ADT_URL;#using-the-adt-installer'>Using the ADT Installer</ulink>"
600 in The Yocto Project Application Development (ADT) User's Manual.</para></listitem> 603 section
604 in the Yocto Project Application Development (ADT) User's Manual.</para></listitem>
601 <listitem><para><emphasis>If Applicable, Secure the Target Root Filesystem</emphasis>: 605 <listitem><para><emphasis>If Applicable, Secure the Target Root Filesystem</emphasis>:
602 If you choose not to install the ADT using the ADT Installer, 606 If you choose not to install the ADT using the ADT Installer,
603 you need to find and download the 607 you need to find and download the
@@ -641,13 +645,14 @@ WRITER NOTE: The areas to get the kernel and root filesystem are located in the
641 <orderedlist> 645 <orderedlist>
642 <listitem><para><emphasis>Install the cross-development toolchain for your target hardware:</emphasis> 646 <listitem><para><emphasis>Install the cross-development toolchain for your target hardware:</emphasis>
643 For information on how to install the toolchain, see the 647 For information on how to install the toolchain, see the
644 "<ulink url='http://www.yoctoproject/docs/1.1/adt-manual/adt-manual.html#using-an-existing-toolchain-tarball'>Using a Cross-Toolchain Tarball</ulink>" section 648 "<ulink url='&YOCTO_DOCS_ADT_URL;#using-an-existing-toolchain-tarball'>Using a Cross-Toolchain Tarball</ulink>"
645 in The Yocto Project Application Development (ADT) User's Manual.</para></listitem> 649 section
650 in the Yocto Project Application Development (ADT) User's Manual.</para></listitem>
646 <listitem><para><emphasis>Download the Target Image:</emphasis> The Yocto Project supports 651 <listitem><para><emphasis>Download the Target Image:</emphasis> The Yocto Project supports
647 several target architectures and has many pre-built kernel images and root filesystem 652 several target architectures and has many pre-built kernel images and root filesystem
648 images.</para> 653 images.</para>
649 <para>If you are going to develop your application on hardware, go to the 654 <para>If you are going to develop your application on hardware, go to the
650 <ulink url='http://www.yoctoproject.org/downloads/yocto-1.1/machines/'> 655 <ulink url='&YOCTO_MACHINES_DL_URL;'>
651 <filename>machines</filename></ulink> download area and choose a target machine area 656 <filename>machines</filename></ulink> download area and choose a target machine area
652 from which to download the kernel image and root filesystem. 657 from which to download the kernel image and root filesystem.
653 This download area could have several files in it that support development using 658 This download area could have several files in it that support development using
@@ -657,7 +662,7 @@ WRITER NOTE: The areas to get the kernel and root filesystem are located in the
657 Be sure to get the files you need for your particular development process.</para> 662 Be sure to get the files you need for your particular development process.</para>
658 <para>If you are going to develop your application and then run and test it using the QEMU 663 <para>If you are going to develop your application and then run and test it using the QEMU
659 emulator, go to the 664 emulator, go to the
660 <ulink url='http://www.yoctoproject.org/downloads/yocto-1.1/machines/qemu/'> 665 <ulink url='&YOCTO_QEMU_DL_URL;'>
661 <filename>machines/qemu</filename></ulink> download area. 666 <filename>machines/qemu</filename></ulink> download area.
662 From this area, go down into the directory for your target architecture 667 From this area, go down into the directory for your target architecture
663 (e.g. <filename>qemux86_64</filename> for an 668 (e.g. <filename>qemux86_64</filename> for an
@@ -665,7 +670,7 @@ WRITER NOTE: The areas to get the kernel and root filesystem are located in the
665 Download kernel, root filesystem, and any other files you need for your process. 670 Download kernel, root filesystem, and any other files you need for your process.
666 <note>In order to use the root filesystem in QEMU, you need to extract it. 671 <note>In order to use the root filesystem in QEMU, you need to extract it.
667 See the 672 See the
668 "<ulink url='http://www.yoctoproject.org/docs/latest/adt-manual/adt-manual.html#extracting-the-root-filesystem'>Extracting the Root Filesystem</ulink>" section for information on how to extract the 673 "<ulink url='&YOCTO_DOCS_ADT_URL;#extracting-the-root-filesystem'>Extracting the Root Filesystem</ulink>" section for information on how to extract the
669 root filesystem.</note></para></listitem> 674 root filesystem.</note></para></listitem>
670 <listitem><para><emphasis>Develop and Test your Application:</emphasis> At this point, 675 <listitem><para><emphasis>Develop and Test your Application:</emphasis> At this point,
671 you have the tools to develop your application. 676 you have the tools to develop your application.
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml
index cf6f700377..1da05e20df 100644
--- a/documentation/dev-manual/dev-manual-newbie.xml
+++ b/documentation/dev-manual/dev-manual-newbie.xml
@@ -1,5 +1,6 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
3 4
4<chapter id='dev-manual-newbie'> 5<chapter id='dev-manual-newbie'>
5 6
@@ -122,7 +123,7 @@
122 123
123 <para> 124 <para>
124 The Yocto Project team maintains complete source repositories for all Yocto Project files 125 The Yocto Project team maintains complete source repositories for all Yocto Project files
125 at <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi'></ulink>. 126 at <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi'></ulink>.
126 This web-based source code browser is organized into categories by function such as 127 This web-based source code browser is organized into categories by function such as
127 IDE Plugins, Matchbox, Poky, Yocto Linux Kernel, and so forth. 128 IDE Plugins, Matchbox, Poky, Yocto Linux Kernel, and so forth.
128 From the interface, you can click on any particular item in the "Name" column and 129 From the interface, you can click on any particular item in the "Name" column and
@@ -143,7 +144,7 @@
143 144
144 <para> 145 <para>
145 For any supported release of Yocto Project, you can go to the Yocto Project website’s 146 For any supported release of Yocto Project, you can go to the Yocto Project website’s
146 <ulink url='http://www.yoctoproject.org/download'>download page</ulink> and get a 147 <ulink url='&YOCTO_HOME_URL;/download'>download page</ulink> and get a
147 tarball of the release. 148 tarball of the release.
148 You can also go to this site to download any supported BSP tarballs. 149 You can also go to this site to download any supported BSP tarballs.
149 Unpacking the tarball gives you a hierarchical directory structure of Yocto Project 150 Unpacking the tarball gives you a hierarchical directory structure of Yocto Project
@@ -158,14 +159,14 @@
158 <para> 159 <para>
159 In summary, here is where you can get the Yocto Project files needed for development: 160 In summary, here is where you can get the Yocto Project files needed for development:
160 <itemizedlist> 161 <itemizedlist>
161 <listitem><para id='source-repositories'><emphasis><ulink url='http://git.yoctoproject.org/cgit/cgit.cgi'>Source Repositories:</ulink></emphasis> 162 <listitem><para id='source-repositories'><emphasis><ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi'>Source Repositories:</ulink></emphasis>
162 This area contains IDE Plugins, Matchbox, Poky, Poky Support, Tools, Yocto Linux Kernel, and Yocto 163 This area contains IDE Plugins, Matchbox, Poky, Poky Support, Tools, Yocto Linux Kernel, and Yocto
163 Metadata Layers. 164 Metadata Layers.
164 You can create Git repositories for each of these areas.</para> 165 You can create Git repositories for each of these areas.</para>
165 <para> 166 <para>
166 <imagedata fileref="figures/source-repos.png" align="center" width="6in" depth="4in" /> 167 <imagedata fileref="figures/source-repos.png" align="center" width="6in" depth="4in" />
167 </para></listitem> 168 </para></listitem>
168 <listitem><para><anchor id='index-downloads' /><emphasis><ulink url='http://downloads.yoctoproject.org/releases/'>Index of /releases:</ulink></emphasis> 169 <listitem><para><anchor id='index-downloads' /><emphasis><ulink url='&YOCTO_DL_URL;/releases/'>Index of /releases:</ulink></emphasis>
169 This area contains index releases such as 170 This area contains index releases such as
170 the <trademark class='trade'>Eclipse</trademark> 171 the <trademark class='trade'>Eclipse</trademark>
171 Yocto Plug-in, miscellaneous support, Poky, pseudo, cross-development toolchains, 172 Yocto Plug-in, miscellaneous support, Poky, pseudo, cross-development toolchains,
@@ -175,11 +176,11 @@
175 <para> 176 <para>
176 <imagedata fileref="figures/index-downloads.png" align="center" width="6in" depth="4in" /> 177 <imagedata fileref="figures/index-downloads.png" align="center" width="6in" depth="4in" />
177 </para></listitem> 178 </para></listitem>
178 <listitem><para><emphasis><ulink url='http://www.yoctoproject.org/download'>Yocto Project Download Page</ulink></emphasis> 179 <listitem><para><emphasis><ulink url='&YOCTO_HOME_URL;/download'>Yocto Project Download Page</ulink></emphasis>
179 This page on the Yocto Project website allows you to download any Yocto Project 180 This page on the Yocto Project website allows you to download any Yocto Project
180 release or Board Support Package (BSP) in tarball form. 181 release or Board Support Package (BSP) in tarball form.
181 The tarballs are similar to those found in the 182 The tarballs are similar to those found in the
182 <ulink url='http://downloads.yoctoproject.org/releases/'>Index of /releases:</ulink> area.</para> 183 <ulink url='&YOCTO_DL_URL;/releases/'>Index of /releases:</ulink> area.</para>
183 <para> 184 <para>
184 <imagedata fileref="figures/yp-download.png" align="center" width="6in" depth="4in" /> 185 <imagedata fileref="figures/yp-download.png" align="center" width="6in" depth="4in" />
185 </para></listitem> 186 </para></listitem>
@@ -239,12 +240,12 @@
239 Images are the binary output that runs on specific hardware and for specific 240 Images are the binary output that runs on specific hardware and for specific
240 use cases. 241 use cases.
241 For a list of the supported image types that the Yocto Project provides, see the 242 For a list of the supported image types that the Yocto Project provides, see the
242 "<ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#ref-images'>Reference: Images</ulink>" 243 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink>"
243 appendix in The Yocto Project Reference Manual.</para></listitem> 244 appendix in The Yocto Project Reference Manual.</para></listitem>
244 <listitem><para id='layer'><emphasis>Layer:</emphasis> A collection of recipes representing the core, 245 <listitem><para id='layer'><emphasis>Layer:</emphasis> A collection of recipes representing the core,
245 a BSP, or an application stack. 246 a BSP, or an application stack.
246 For a discussion on BSP Layers, see the 247 For a discussion on BSP Layers, see the
247 "<ulink url='http://www.yoctoproject.org/docs/latest/bsp-guide/bsp-guide.html#bsp-layers'>BSP Layers</ulink>" 248 "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>"
248 section in the Yocto Project Board Support Packages (BSP) Developer's Guide.</para></listitem> 249 section in the Yocto Project Board Support Packages (BSP) Developer's Guide.</para></listitem>
249 <listitem><para id='metadata'><emphasis>Metadata:</emphasis> The files that BitBake parses when 250 <listitem><para id='metadata'><emphasis>Metadata:</emphasis> The files that BitBake parses when
250 building an image. 251 building an image.
@@ -283,44 +284,42 @@
283 by cloning <filename>git://git.yoctoproject.org/poky</filename>. 284 by cloning <filename>git://git.yoctoproject.org/poky</filename>.
284 Sometimes the term "the Yocto Project Files structure" is used as well.</para> 285 Sometimes the term "the Yocto Project Files structure" is used as well.</para>
285 286
286 <para>The Yocto Project files contain BitBake, Documentation, metadata and 287 <para>The Yocto Project Files contain BitBake, Documentation, metadata and
287 other files that all support the development environment. 288 other files that all support the development environment.
288 Consequently, you must have the Yocto Project files in place on your development 289 Consequently, you must have the Yocto Project Files in place on your development
289 system in order to do any development using the Yocto Project.</para> 290 system in order to do any development using the Yocto Project.</para>
290 291
291 <para>The name of the top-level directory of the Yocto Project file structure 292 <para>The name of the top-level directory of the Yocto Project Files structure
292 is derived from the Yocto Project release tarball. 293 is derived from the Yocto Project release tarball.
293 For example, downloading and unpacking <filename>poky-edison-6.0.tar.bz2</filename> 294 For example, downloading and unpacking <filename>&YOCTO_POKY_TARBALL;</filename>
294 results in a Yocto Project file structure whose Yocto Project source directory is named 295 results in a Yocto Project file structure whose Yocto Project source directory is named
295 <filename>poky-edison-6.0</filename>. 296 <filename>&YOCTO_POKY;</filename>.
296 If you create a Git repository, then you can name the repository anything you like. 297 If you create a Git repository, then you can name the repository anything you like.
297 By default, your local Git repository is named <filename>poky</filename>.</para> 298 Throughout much of the documentation, the name of the Git repository is used as the
299 name for the local folder.
300 So, for example, cloning the <filename>poky</filename> Git repository results in a
301 local Git repository also named <filename>poky</filename>.</para>
298 302
299 <para>It is important to understand the differences between Yocto Project Files created 303 <para>It is important to understand the differences between Yocto Project Files created
300 by unpacking a release tarball as compared to cloning 304 by unpacking a release tarball as compared to cloning
301 <filename>git://git.yoctoproject.org/poky</filename>. 305 <filename>git://git.yoctoproject.org/poky</filename>.
302 When you unpack a tarball, you have an exact copy of the files based on the time of 306 When you unpack a tarball, you have an exact copy of the files based on the time of
303 release - a fixed release point. 307 release - a fixed release point.
304 Any changes you make to your local Yocto Project files are on top of the release. 308 Any changes you make to your local Yocto Project Files are on top of the release.
305 On the other hand, when you clone the Yocto Project Git repository, you have an 309 On the other hand, when you clone the Yocto Project Git repository, you have an
306 active development repository. 310 active development repository.
307 creates a build directory named <filename>YP-6.0</filename> 311 In this case, any local changes you make to the Yocto Project can be later applied
308 in your home directory within the directory <filename>mybuilds</filename>. 312 to active development branches of the upstream Yocto Project Git repository.</para>
309 If <filename>mybuilds</filename> does not exist it is created for you. In this case, any local changes you make to the Yocto Project can be later applied to active 313
310 development branches of the upstream Yocto Project Git repository. 314 <para>Finally, if you want to track a set of local changes while starting from the same point
311 If you want to track a set of local changes while starting from the same point
312 as a release tarball, you can create a local Git branch that 315 as a release tarball, you can create a local Git branch that
313 reflects the exact copy of the files at the time of their release. 316 reflects the exact copy of the files at the time of their release.
314 You do this using Git tags that are part of the repository. 317 You do this using Git tags that are part of the repository.</para>
315 For more information on concepts, see the section 318
316 "<link linkend='repositories-tags-and-branches'>Repositories, Tags, and Branches</link>". 319 <para>For more information on concepts around Git repositories, branches, and tags,
317 </para> 320 see the
318 321 "<link linkend='repositories-tags-and-branches'>Repositories, Tags, and Branches</link>"
319 <para>You can find instruction on how to set up the Yocto Project files on your 322 section.</para></listitem>
320 host development system by reading
321 the
322 "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#getting-setup'>Getting
323 Setup</ulink>" section.</para></listitem>
324 <listitem> 323 <listitem>
325 <para id='yocto-project-build-directory'><emphasis>Yocto Project Build Directory:</emphasis> 324 <para id='yocto-project-build-directory'><emphasis>Yocto Project Build Directory:</emphasis>
326 This term refers to the area used by the Yocto Project for builds. 325 This term refers to the area used by the Yocto Project for builds.
@@ -341,17 +340,17 @@
341 </literallayout></para></listitem> 340 </literallayout></para></listitem>
342 <listitem><para>Provide a directory path and specifically name the build 341 <listitem><para>Provide a directory path and specifically name the build
343 directory. 342 directory.
344 This next example creates a build directory named <filename>YP-6.0</filename> 343 This next example creates a build directory named <filename>YP-&POKYVERSION;</filename>
345 in your home directory within the directory <filename>mybuilds</filename>. 344 in your home directory within the directory <filename>mybuilds</filename>.
346 If <filename>mybuilds</filename> does not exist, the directory is created for you: 345 If <filename>mybuilds</filename> does not exist, the directory is created for you:
347 <literallayout class='monospaced'> 346 <literallayout class='monospaced'>
348 $ source poky-edison-6.0/oe-init-build-env $HOME/mybuilds/YP-6.0 347 $ source &OE_INIT_PATH; $HOME/mybuilds/YP-&POKYVERSION;
349 </literallayout></para></listitem> 348 </literallayout></para></listitem>
350 <listitem><para>Provide an existing directory to use as the build directory. 349 <listitem><para>Provide an existing directory to use as the build directory.
351 This example uses the existing <filename>mybuilds</filename> directory 350 This example uses the existing <filename>mybuilds</filename> directory
352 as the build directory. 351 as the build directory.
353 <literallayout class='monospaced'> 352 <literallayout class='monospaced'>
354 $ source poky-edison-6.0/oe-init-build-env $HOME/mybuilds/ 353 $ source &OE_INIT_PATH; $HOME/mybuilds/
355 </literallayout></para></listitem> 354 </literallayout></para></listitem>
356 </itemizedlist> 355 </itemizedlist>
357 </para></listitem> 356 </para></listitem>
@@ -419,7 +418,7 @@
419 418
420 <para> 419 <para>
421 You can find a list of the combined SPDX and OSI licenses that the Yocto Project uses 420 You can find a list of the combined SPDX and OSI licenses that the Yocto Project uses
422 <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/files/common-licenses'>here</ulink>. 421 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/files/common-licenses'>here</ulink>.
423 This wiki page discusses the license infrastructure used by the Yocto Project. 422 This wiki page discusses the license infrastructure used by the Yocto Project.
424 </para> 423 </para>
425</section> 424</section>
@@ -449,7 +448,7 @@
449 As mentioned earlier in section 448 As mentioned earlier in section
450 "<link linkend='yocto-project-repositories'>Yocto Project Source Repositories</link>", 449 "<link linkend='yocto-project-repositories'>Yocto Project Source Repositories</link>",
451 the Yocto Project maintains source repositories at 450 the Yocto Project maintains source repositories at
452 <ulink url='http://git.yoctoproject.org/cgit.cgi'></ulink>. 451 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.
453 If you look at this web-interface of the repositories, each item is a separate 452 If you look at this web-interface of the repositories, each item is a separate
454 Git repository. 453 Git repository.
455 </para> 454 </para>
@@ -489,9 +488,9 @@
489 <filename>edison</filename>, and <filename>master</filename> branches among 488 <filename>edison</filename>, and <filename>master</filename> branches among
490 others. 489 others.
491 You can see all the branches by going to 490 You can see all the branches by going to
492 <ulink url='http://git.yoctoproject.org/cgit.cgi/poky/'></ulink> and 491 <ulink url='&YOCTO_GIT_URL;/cgit.cgi/poky/'></ulink> and
493 clicking on the 492 clicking on the
494 <filename><ulink url='http://git.yoctoproject.org/cgit.cgi/poky/refs/heads'>[...]</ulink></filename> 493 <filename><ulink url='&YOCTO_GIT_URL;/cgit.cgi/poky/refs/heads'>[...]</ulink></filename>
495 link beneath the "Branch" heading. 494 link beneath the "Branch" heading.
496 </para> 495 </para>
497 496
@@ -512,19 +511,19 @@
512 branch in the repository. 511 branch in the repository.
513 To help illustrate, here is a set of commands that creates a local copy of the 512 To help illustrate, here is a set of commands that creates a local copy of the
514 <filename>poky</filename> Git repository and then creates and checks out a local 513 <filename>poky</filename> Git repository and then creates and checks out a local
515 Git branch that tracks the Yocto Project 1.1 Release (edison) development: 514 Git branch that tracks the Yocto Project &DISTRO; Release (&DISTRO_NAME;) development:
516 <literallayout class='monospaced'> 515 <literallayout class='monospaced'>
517 $ cd ~ 516 $ cd ~
518 $ git clone git://git.yoctoproject.org/poky 517 $ git clone git://git.yoctoproject.org/poky
519 $ cd poky 518 $ cd poky
520 $ git checkout edison -b edison 519 $ git checkout &DISTRO_NAME; -b &DISTRO_NAME;
521 </literallayout> 520 </literallayout>
522 In this example, the name of the top-level directory of your local Yocto Project 521 In this example, the name of the top-level directory of your local Yocto Project
523 Files Git repository is <filename>poky</filename>. 522 Files Git repository is <filename>poky</filename>.
524 And, the name of the local working area (or local branch) you have created and checked 523 And, the name of the local working area (or local branch) you have created and checked
525 out is named <filename>edison</filename>. 524 out is named <filename>&DISTRO_NAME;</filename>.
526 The files in your repository now reflect the same files that are in the 525 The files in your repository now reflect the same files that are in the
527 <filename>edison</filename> development branch of the Yocto Project's 526 <filename>&DISTRO_NAME;</filename> development branch of the Yocto Project's
528 <filename>poky</filename> repository. 527 <filename>poky</filename> repository.
529 It is important to understand that when you create and checkout a 528 It is important to understand that when you create and checkout a
530 local working branch based on a branch name, 529 local working branch based on a branch name,
@@ -532,8 +531,8 @@
532 at the time you created your local branch, which could be 531 at the time you created your local branch, which could be
533 different than the files at the time of a similarly named release. 532 different than the files at the time of a similarly named release.
534 In other words, creating and checking out a local branch based on the 533 In other words, creating and checking out a local branch based on the
535 <filename>edison</filename> branch name is not the same as creating and 534 <filename>&DISTRO_NAME;</filename> branch name is not the same as creating and
536 checking out a local branch based on the <filename>edison-6.0</filename> 535 checking out a local branch based on the <filename>&DISTRO_NAME;-&DISTRO;</filename>
537 release. 536 release.
538 Keep reading to see how you create a local snapshot of a Yocto Project Release. 537 Keep reading to see how you create a local snapshot of a Yocto Project Release.
539 </para> 538 </para>
@@ -543,15 +542,15 @@
543 Typically, a tag is used to mark a special point such as the final change 542 Typically, a tag is used to mark a special point such as the final change
544 before a project is released. 543 before a project is released.
545 You can see the tags used with the <filename>poky</filename> Git repository 544 You can see the tags used with the <filename>poky</filename> Git repository
546 by going to <ulink url='http://git.yoctoproject.org/cgit.cgi/poky/'></ulink> and 545 by going to <ulink url='&YOCTO_GIT_URL;/cgit.cgi/poky/'></ulink> and
547 clicking on the 546 clicking on the
548 <filename><ulink url='http://git.yoctoproject.org/cgit.cgi/poky/refs/tags'>[...]</ulink></filename> 547 <filename><ulink url='&YOCTO_GIT_URL;/cgit.cgi/poky/refs/tags'>[...]</ulink></filename>
549 link beneath the "Tag" heading. 548 link beneath the "Tag" heading.
550 </para> 549 </para>
551 550
552 <para> 551 <para>
553 Some key tags are <filename>laverne-4.0</filename>, <filename>bernard-5.0</filename>, 552 Some key tags are <filename>laverne-4.0</filename>, <filename>bernard-5.0</filename>,
554 and <filename>edison-6.0</filename>. 553 and <filename>&DISTRO_NAME;-&POKYVERSION;</filename>.
555 These tags represent Yocto Project releases. 554 These tags represent Yocto Project releases.
556 </para> 555 </para>
557 556
@@ -569,14 +568,14 @@
569 $ cd ~ 568 $ cd ~
570 $ git clone git://git.yoctoproject.org/poky 569 $ git clone git://git.yoctoproject.org/poky
571 $ cd poky 570 $ cd poky
572 $ git checkout edison-6.0 -b edison-6.0 571 $ git checkout &DISTRO_NAME;-&POKYVERSION; -b &DISTRO_NAME;-&POKYVERSION;
573 </literallayout> 572 </literallayout>
574 In this example, the name of the top-level directory of your local Yocto Project 573 In this example, the name of the top-level directory of your local Yocto Project
575 Files Git repository is <filename>poky</filename>. 574 Files Git repository is <filename>poky</filename>.
576 And, the name of the local branch you have created and checked out is 575 And, the name of the local branch you have created and checked out is
577 <filename>edison-6.0</filename>. 576 <filename>&DISTRO_NAME;-&POKYVERSION;</filename>.
578 The files in your repository now exactly match the Yocto Project 1.1 577 The files in your repository now exactly match the Yocto Project &DISTRO;
579 Release tag (edison). 578 Release tag (&DISTRO_NAME;).
580 It is important to understand that when you create and checkout a local 579 It is important to understand that when you create and checkout a local
581 working branch based on a tag, your environment matches a specific point 580 working branch based on a tag, your environment matches a specific point
582 in time and not a development branch. 581 in time and not a development branch.
@@ -807,7 +806,7 @@
807 changes, can be used to communicate changes and problems with developers, can be used to 806 changes, can be used to communicate changes and problems with developers, can be used to
808 submit and review patches, and can be used to manage quality assurance. 807 submit and review patches, and can be used to manage quality assurance.
809 The home page for the Yocto Project implementation of Bugzilla is 808 The home page for the Yocto Project implementation of Bugzilla is
810 <ulink url='http://bugzilla.yoctoproject.org'>http://bugzilla.yoctoproject.org</ulink>. 809 <ulink url='&YOCTO_BUGZILLA_URL;'>&YOCTO_BUGZILLA_URL;</ulink>.
811 </para> 810 </para>
812 811
813 <para> 812 <para>
@@ -818,7 +817,7 @@
818 Bugzilla. 817 Bugzilla.
819 You can find more information on defect management, bug tracking, and feature request 818 You can find more information on defect management, bug tracking, and feature request
820 processes all accomplished through the Yocto Project Bugzilla on the wiki page 819 processes all accomplished through the Yocto Project Bugzilla on the wiki page
821 <ulink url='https://wiki.yoctoproject.org/wiki/Bugzilla_Configuration_and_Bug_Tracking'>here</ulink>. 820 <ulink url='&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking'>here</ulink>.
822 <orderedlist> 821 <orderedlist>
823 <listitem><para>Always use the Yocto Project implementation of Bugzilla to submit 822 <listitem><para>Always use the Yocto Project implementation of Bugzilla to submit
824 a bug.</para></listitem> 823 a bug.</para></listitem>
@@ -866,7 +865,7 @@
866 You should send patches to the appropriate Yocto Project mailing list to get them 865 You should send patches to the appropriate Yocto Project mailing list to get them
867 in front of the Yocto Project Maintainer. 866 in front of the Yocto Project Maintainer.
868 For a list of the Yocto Project mailing lists, see the 867 For a list of the Yocto Project mailing lists, see the
869 "<ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#resources-mailinglist'>Mailing lists</ulink>" section in 868 "<ulink url='&YOCTO_DOCS_REF_URL;#resources-mailinglist'>Mailing lists</ulink>" section in
870 The Yocto Project Reference Manual. 869 The Yocto Project Reference Manual.
871 </para> 870 </para>
872 871
@@ -875,14 +874,14 @@
875 <itemizedlist> 874 <itemizedlist>
876 <listitem><para>For defects against the Yocto Project build system Poky, send 875 <listitem><para>For defects against the Yocto Project build system Poky, send
877 your patch to the 876 your patch to the
878 <ulink url='http://lists.yoctoproject.org/listinfo/poky'></ulink> mailing list. 877 <ulink url='&YOCTO_LISTS_URL;/listinfo/poky'></ulink> mailing list.
879 This mailing list corresponds to issues that are not specific to the Yocto Project but 878 This mailing list corresponds to issues that are not specific to the Yocto Project but
880 are part of the OE-core. 879 are part of the OE-core.
881 For example, a defect against anything in the <filename>meta</filename> layer 880 For example, a defect against anything in the <filename>meta</filename> layer
882 or the BitBake Manual could be sent to this mailing list.</para></listitem> 881 or the BitBake Manual could be sent to this mailing list.</para></listitem>
883 <listitem><para>For defects against Yocto-specific layers, tools, and Yocto Project 882 <listitem><para>For defects against Yocto-specific layers, tools, and Yocto Project
884 documentation use the 883 documentation use the
885 <ulink url='http://lists.yoctoproject.org/listinfo/yocto'></ulink> mailing list. 884 <ulink url='&YOCTO_LISTS_URL;/listinfo/yocto'></ulink> mailing list.
886 This mailing list corresponds to Yocto-specific areas such as 885 This mailing list corresponds to Yocto-specific areas such as
887 <filename>meta-yocto</filename>, <filename>meta-intel</filename>, 886 <filename>meta-yocto</filename>, <filename>meta-intel</filename>,
888 <filename>linux-yocto</filename>, and <filename>documentation</filename>.</para></listitem> 887 <filename>linux-yocto</filename>, and <filename>documentation</filename>.</para></listitem>
@@ -973,7 +972,7 @@
973 <para> 972 <para>
974 You can find more guidance on creating well-formed commit messages at this OpenEmbedded 973 You can find more guidance on creating well-formed commit messages at this OpenEmbedded
975 wiki page: 974 wiki page:
976 <ulink url='http://www.openembedded.org/wiki/Commit_Patch_Message_Guidelines'></ulink>. 975 <ulink url='&OE_HOME_URL;/wiki/Commit_Patch_Message_Guidelines'></ulink>.
977 </para> 976 </para>
978 977
979 <para> 978 <para>
@@ -1089,22 +1088,6 @@
1089 </para> 1088 </para>
1090 </section> 1089 </section>
1091</section> 1090</section>
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108</chapter> 1091</chapter>
1109<!-- 1092<!--
1110vim: expandtab tw=80 ts=4 1093vim: expandtab tw=80 ts=4
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index 53db4da056..fbebe4d65e 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -1,5 +1,6 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
3 4
4<chapter id='dev-manual-start'> 5<chapter id='dev-manual-start'>
5 6
@@ -9,7 +10,7 @@
9 This chapter introduces the Yocto Project and gives you an idea of what you need to get started. 10 This chapter introduces the Yocto Project and gives you an idea of what you need to get started.
10 You can find enough information to set up your development host and build or use images for 11 You can find enough information to set up your development host and build or use images for
11 hardware supported by the Yocto Project by reading 12 hardware supported by the Yocto Project by reading
12 <ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html'> 13 <ulink url='&YOCTO_DOCS_QS_URL;'>
13 The Yocto Project Quick Start</ulink>. 14 The Yocto Project Quick Start</ulink>.
14</para> 15</para>
15 16
@@ -57,7 +58,7 @@
57 </para></listitem> 58 </para></listitem>
58 <listitem><para><emphasis>Packages:</emphasis> The Yocto Project requires certain packages 59 <listitem><para><emphasis>Packages:</emphasis> The Yocto Project requires certain packages
59 exist on your development system (e.g. Python 2.6 or 2.7). 60 exist on your development system (e.g. Python 2.6 or 2.7).
60 See "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#packages'>The Packages</ulink>" 61 See "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>"
61 section in the Yocto Project Quick start for the exact package 62 section in the Yocto Project Quick start for the exact package
62 requirements and the installation commands to install them 63 requirements and the installation commands to install them
63 for the supported distributions.</para></listitem> 64 for the supported distributions.</para></listitem>
@@ -75,13 +76,14 @@
75 <itemizedlist> 76 <itemizedlist>
76 <listitem><para><emphasis>Tarball Extraction:</emphasis> If you are not going to contribute 77 <listitem><para><emphasis>Tarball Extraction:</emphasis> If you are not going to contribute
77 back into the Yocto Project, you can simply download the Yocto Project release you want 78 back into the Yocto Project, you can simply download the Yocto Project release you want
78 from the website’s <ulink url='http://yoctoproject.org/download'>download page</ulink>. 79 from the website’s <ulink url='&YOCTO_HOME_URL;/download'>download page</ulink>.
79 Once you have the tarball, just extract it into a directory of your choice.</para> 80 Once you have the tarball, just extract it into a directory of your choice.</para>
80 <para>For example, the following command extracts the Yocto Project 1.1 release tarball 81 <para>For example, the following command extracts the Yocto Project &DISTRO;
82 release tarball
81 into the current working directory and sets up the Yocto Project file structure 83 into the current working directory and sets up the Yocto Project file structure
82 with a top-level directory named <filename>poky-edison-6.0</filename>: 84 with a top-level directory named <filename>&YOCTO_POKY;</filename>:
83 <literallayout class='monospaced'> 85 <literallayout class='monospaced'>
84 $ tar xfj poky-edison-6.0.tar.bz2 86 $ tar xfj &YOCTO_POKY_TARBALL;
85 </literallayout></para> 87 </literallayout></para>
86 <para>This method does not produce a Git repository. 88 <para>This method does not produce a Git repository.
87 Instead, you simply end up with a local snapshot of the 89 Instead, you simply end up with a local snapshot of the
@@ -100,7 +102,7 @@
100 <note>The name of the Yocto Project Files Git repository in the Yocto Project Files 102 <note>The name of the Yocto Project Files Git repository in the Yocto Project Files
101 Source Repositories is <filename>poky</filename>. 103 Source Repositories is <filename>poky</filename>.
102 You can view the Yocto Project Source Repositories at 104 You can view the Yocto Project Source Repositories at
103 <ulink url='http://git.yoctoproject.org/cgit.cgi'></ulink></note> 105 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink></note>
104 The command creates the local repository in a directory named <filename>poky</filename>. 106 The command creates the local repository in a directory named <filename>poky</filename>.
105 For information on Git used within the Yocto Project, see the 107 For information on Git used within the Yocto Project, see the
106 "<link linkend='git'>Git</link>" section. 108 "<link linkend='git'>Git</link>" section.
@@ -111,9 +113,10 @@
111 remote: Compressing objects: 100% (35987/35987), done. 113 remote: Compressing objects: 100% (35987/35987), done.
112 remote: Total 116882 (delta 80651), reused 113045 (delta 77578) 114 remote: Total 116882 (delta 80651), reused 113045 (delta 77578)
113 Receiving objects: 100% (116882/116882), 72.13 MiB | 2.68 MiB/s, done. 115 Receiving objects: 100% (116882/116882), 72.13 MiB | 2.68 MiB/s, done.
114 Resolving deltas: 100% (80651/80651), done. </literallayout></para> 116 Resolving deltas: 100% (80651/80651), done.
117 </literallayout></para>
115 <para>For another example of how to set up your own local Git repositories, see this 118 <para>For another example of how to set up your own local Git repositories, see this
116 <ulink url='https://wiki.yoctoproject.org/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'> 119 <ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'>
117 wiki page</ulink>, which describes how to create both <filename>poky</filename> 120 wiki page</ulink>, which describes how to create both <filename>poky</filename>
118 and <filename>meta-intel</filename> Git repositories.</para></listitem> 121 and <filename>meta-intel</filename> Git repositories.</para></listitem>
119 </itemizedlist></para></listitem> 122 </itemizedlist></para></listitem>
@@ -122,7 +125,7 @@
122 need to establish local copies of the source. 125 need to establish local copies of the source.
123 You can find Git repositories of supported Linux Yocto Kernels organized under 126 You can find Git repositories of supported Linux Yocto Kernels organized under
124 "Yocto Linux Kernel" in the Yocto Project Source Repositories at 127 "Yocto Linux Kernel" in the Yocto Project Source Repositories at
125 <ulink url='http://git.yoctoproject.org/cgit.cgi'></ulink>.</para> 128 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.</para>
126 <para>This setup involves creating a bare clone of the Linux Yocto kernel and then 129 <para>This setup involves creating a bare clone of the Linux Yocto kernel and then
127 copying that cloned repository. 130 copying that cloned repository.
128 You can create the bare clone and the copy of the bare clone anywhere you like. 131 You can create the bare clone and the copy of the bare clone anywhere you like.
@@ -164,7 +167,7 @@
164 source files from upstream each time you make changes to the kernel.</para> 167 source files from upstream each time you make changes to the kernel.</para>
165 <para>You can find the <filename>poky-extras</filename> Git Repository in the 168 <para>You can find the <filename>poky-extras</filename> Git Repository in the
166 "Yocto Metadata Layers" area of the Yocto Project Source Repositories at 169 "Yocto Metadata Layers" area of the Yocto Project Source Repositories at
167 <ulink url='http://git.yoctoproject.org/cgit.cgi'></ulink>. 170 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.
168 It is good practice to create this Git repository inside the Yocto Project 171 It is good practice to create this Git repository inside the Yocto Project
169 files Git repository.</para> 172 files Git repository.</para>
170 <para>Following is an example that creates the <filename>poky-extras</filename> Git 173 <para>Following is an example that creates the <filename>poky-extras</filename> Git
@@ -185,7 +188,7 @@
185 The Yocto Project provides a layer called <filename>meta-intel</filename> and 188 The Yocto Project provides a layer called <filename>meta-intel</filename> and
186 it is maintained in its own separate Git repository. 189 it is maintained in its own separate Git repository.
187 The <filename>meta-intel</filename> layer contains many supported 190 The <filename>meta-intel</filename> layer contains many supported
188 <ulink url='http://www.yoctoproject.org/docs/latest/bsp-guide/bsp-guide.html#bsp-layers'>BSP Layers</ulink>.</para> 191 <ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>.</para>
189 <para>Similar considerations exist for setting up the <filename>meta-intel</filename> 192 <para>Similar considerations exist for setting up the <filename>meta-intel</filename>
190 layer. 193 layer.
191 You can get set up for BSP development one of two ways: tarball extraction or 194 You can get set up for BSP development one of two ways: tarball extraction or
@@ -204,13 +207,13 @@
204 meta-n450 207 meta-n450
205 </literallayout> 208 </literallayout>
206 See the 209 See the
207 "<ulink url='http://www.yoctoproject.org/docs/latest/bsp-guide/bsp-guide.html#bsp-layers'>BSP Layers</ulink>" 210 "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>"
208 section in the Yocto Project Board Support Package (BSP) Developer's Guide for more 211 section in the Yocto Project Board Support Package (BSP) Developer's Guide for more
209 information on BSP Layers. 212 information on BSP Layers.
210 <itemizedlist> 213 <itemizedlist>
211 <listitem><para><emphasis>Tarball Extraction:</emphasis> You can download any released 214 <listitem><para><emphasis>Tarball Extraction:</emphasis> You can download any released
212 BSP tarball from the same 215 BSP tarball from the same
213 <ulink url='http://yoctoproject.org/download'>download site</ulink> used 216 <ulink url='&YOCTO_HOME_URL;/download'>download site</ulink> used
214 to get the Yocto Project release. 217 to get the Yocto Project release.
215 Once you have the tarball, just extract it into a directory of your choice. 218 Once you have the tarball, just extract it into a directory of your choice.
216 Again, this method just produces a snapshot of the BSP layer in the form 219 Again, this method just produces a snapshot of the BSP layer in the form
@@ -220,7 +223,7 @@
220 to set up the <filename>meta-intel</filename> Git repository. 223 to set up the <filename>meta-intel</filename> Git repository.
221 You can locate the <filename>meta-intel</filename> Git repository in the 224 You can locate the <filename>meta-intel</filename> Git repository in the
222 "Yocto Metadata Layers" area of the Yocto Project Source Repositories at 225 "Yocto Metadata Layers" area of the Yocto Project Source Repositories at
223 <ulink url='http://git.yoctoproject.org/cgit.cgi'></ulink>.</para> 226 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.</para>
224 <para>Typically, you set up the <filename>meta-intel</filename> Git repository inside 227 <para>Typically, you set up the <filename>meta-intel</filename> Git repository inside
225 the Yocto Project Files Git repository. 228 the Yocto Project Files Git repository.
226 For example, the following transcript shows the steps to clone the 229 For example, the following transcript shows the steps to clone the
@@ -237,7 +240,7 @@
237 Resolving deltas: 100% (546/546), done. 240 Resolving deltas: 100% (546/546), done.
238 </literallayout></para> 241 </literallayout></para>
239 <para>The same 242 <para>The same
240 <ulink url='https://wiki.yoctoproject.org/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'> 243 <ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'>
241 wiki page</ulink> referenced earlier covers how to 244 wiki page</ulink> referenced earlier covers how to
242 set up the <filename>meta-intel</filename> Git repository.</para></listitem> 245 set up the <filename>meta-intel</filename> Git repository.</para></listitem>
243 </itemizedlist></para></listitem> 246 </itemizedlist></para></listitem>
@@ -245,7 +248,7 @@
245 applications using the Eclipse Integrated Development Environment (IDE), 248 applications using the Eclipse Integrated Development Environment (IDE),
246 you will need this plug-in. 249 you will need this plug-in.
247 See the 250 See the
248 "<ulink url='http://www.yoctoproject.org/docs/latest/adt-manual/adt-manual.html#setting-up-the-eclipse-ide'>Setting up the Eclipse IDE</ulink>" 251 "<ulink url='&YOCTO_DOCS_ADT_URL;#setting-up-the-eclipse-ide'>Setting up the Eclipse IDE</ulink>"
249 section in the Yocto Application Development Toolkit (ADT) 252 section in the Yocto Application Development Toolkit (ADT)
250 User’s Guide for more information.</para></listitem> 253 User’s Guide for more information.</para></listitem>
251 </itemizedlist> 254 </itemizedlist>
@@ -258,7 +261,7 @@
258 <para> 261 <para>
259 The build process creates an entire Linux distribution, including the toolchain, from source. 262 The build process creates an entire Linux distribution, including the toolchain, from source.
260 For more information on this topic, see the 263 For more information on this topic, see the
261 "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#building-image'>Building an Image</ulink>" 264 "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>"
262 section in the Yocto Project Quick Start. 265 section in the Yocto Project Quick Start.
263 </para> 266 </para>
264 267
@@ -275,15 +278,15 @@
275 is set up how you want it. 278 is set up how you want it.
276 This file defines many aspects of the build environment including 279 This file defines many aspects of the build environment including
277 the target machine architecture through the 280 the target machine architecture through the
278 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-MACHINE'>MACHINE</ulink></filename> variable, 281 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'>MACHINE</ulink></filename> variable,
279 the development machine's processor use through the 282 the development machine's processor use through the
280 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-BB_NUMBER_THREADS'>BB_NUMBER_THREADS</ulink></filename> and 283 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'>BB_NUMBER_THREADS</ulink></filename> and
281 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PARALLEL_MAKE'>PARALLEL_MAKE</ulink></filename> variables, and 284 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'>PARALLEL_MAKE</ulink></filename> variables, and
282 a centralized tarball download directory through the 285 a centralized tarball download directory through the
283 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-DL_DIR'>DL_DIR</ulink></filename> variable.</para></listitem> 286 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-DL_DIR'>DL_DIR</ulink></filename> variable.</para></listitem>
284 <listitem><para>Build the image using the <filename>bitbake</filename> command. 287 <listitem><para>Build the image using the <filename>bitbake</filename> command.
285 If you want information on BitBake, see the user manual at 288 If you want information on BitBake, see the user manual at
286 <ulink url='http://docs.openembedded.org/bitbake/html'></ulink>.</para></listitem> 289 <ulink url='&OE_DOCS_URL;/bitbake/html'></ulink>.</para></listitem>
287 <listitem><para>Run the image either on the actual hardware or using the QEMU 290 <listitem><para>Run the image either on the actual hardware or using the QEMU
288 emulator.</para></listitem> 291 emulator.</para></listitem>
289 </orderedlist> 292 </orderedlist>
@@ -305,7 +308,7 @@
305 308
306 <para> 309 <para>
307 You can find details on all these steps in the 310 You can find details on all these steps in the
308 "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#using-pre-built'>Using Pre-Built Binaries and QEMU</ulink>" 311 "<ulink url='&YOCTO_DOCS_QS_URL;#using-pre-built'>Using Pre-Built Binaries and QEMU</ulink>"
309 section of the Yocto Project Quick Start. 312 section of the Yocto Project Quick Start.
310 </para> 313 </para>
311</section> 314</section>
diff --git a/documentation/dev-manual/dev-manual.xml b/documentation/dev-manual/dev-manual.xml
index ffa7d72a73..15ff0427c7 100644
--- a/documentation/dev-manual/dev-manual.xml
+++ b/documentation/dev-manual/dev-manual.xml
@@ -1,5 +1,6 @@
1<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 1<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
3 4
4<book id='dev-manual' lang='en' 5<book id='dev-manual' lang='en'
5 xmlns:xi="http://www.w3.org/2003/XInclude" 6 xmlns:xi="http://www.w3.org/2003/XInclude"
@@ -36,7 +37,7 @@
36 </revhistory> 37 </revhistory>
37 38
38 <copyright> 39 <copyright>
39 <year>2010-2012</year> 40 <year>&COPYRIGHT_YEAR;</year>
40 <holder>Linux Foundation</holder> 41 <holder>Linux Foundation</holder>
41 </copyright> 42 </copyright>
42 43
@@ -51,9 +52,9 @@
51 <note> 52 <note>
52 Due to production processes, there could be differences between the Yocto Project 53 Due to production processes, there could be differences between the Yocto Project
53 documentation bundled in the release tarball and 54 documentation bundled in the release tarball and
54 <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html'> 55 <ulink url='&YOCTO_DOCS_DEV_URL;'>
55 The Yocto Project Development Manual</ulink> on 56 The Yocto Project Development Manual</ulink> on
56 the <ulink url='http://www.yoctoproject.org'>Yocto Project</ulink> website. 57 the <ulink url='&YOCTO_HOME_URL;'>Yocto Project</ulink> website.
57 For the latest version of this manual, see the manual on the website. 58 For the latest version of this manual, see the manual on the website.
58 </note> 59 </note>
59 </legalnotice> 60 </legalnotice>