summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/dev-manual-bsp-appendix.xml2
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml4
-rw-r--r--documentation/dev-manual/dev-manual-kernel-appendix.xml16
-rw-r--r--documentation/dev-manual/dev-manual-model.xml46
-rw-r--r--documentation/dev-manual/dev-manual-start.xml12
5 files changed, 40 insertions, 40 deletions
diff --git a/documentation/dev-manual/dev-manual-bsp-appendix.xml b/documentation/dev-manual/dev-manual-bsp-appendix.xml
index e3f8f7664c..4cc348682c 100644
--- a/documentation/dev-manual/dev-manual-bsp-appendix.xml
+++ b/documentation/dev-manual/dev-manual-bsp-appendix.xml
@@ -266,7 +266,7 @@
266 <filename>PREFERRED_VERSION_linux-yocto</filename> statement. 266 <filename>PREFERRED_VERSION_linux-yocto</filename> statement.
267 This statement identifies the kernel that the BSP is going to use. 267 This statement identifies the kernel that the BSP is going to use.
268 In this case, the BSP is using <filename>linux-yocto</filename>, which is the 268 In this case, the BSP is using <filename>linux-yocto</filename>, which is the
269 current Linux Yocto kernel based on the Linux 3.2 release. 269 current Yocto Project kernel based on the Linux 3.2 release.
270 </para> 270 </para>
271 271
272 <para> 272 <para>
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index f326dc5209..3e0b94665e 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -1311,7 +1311,7 @@
1311 <title>Configuring the Kernel</title> 1311 <title>Configuring the Kernel</title>
1312 1312
1313 <para> 1313 <para>
1314 Configuring the Linux Yocto kernel consists of making sure the <filename>.config</filename> 1314 Configuring the Yocto Project kernel consists of making sure the <filename>.config</filename>
1315 file has all the right information in it for the image you are building. 1315 file has all the right information in it for the image you are building.
1316 You can use the <filename>menuconfig</filename> tool and configuration fragments to 1316 You can use the <filename>menuconfig</filename> tool and configuration fragments to
1317 make sure your <filename>.config</filename> file is just how you need it. 1317 make sure your <filename>.config</filename> file is just how you need it.
@@ -1404,7 +1404,7 @@
1404 </para> 1404 </para>
1405 1405
1406 <para> 1406 <para>
1407 As part of the Linux Yocto kernel build process, the 1407 As part of the kernel build process, the
1408 <filename>kernel_configcheck</filename> task runs. 1408 <filename>kernel_configcheck</filename> task runs.
1409 This task validates the kernel configuration by checking the final 1409 This task validates the kernel configuration by checking the final
1410 <filename>.config</filename> file against the input files. 1410 <filename>.config</filename> file against the input files.
diff --git a/documentation/dev-manual/dev-manual-kernel-appendix.xml b/documentation/dev-manual/dev-manual-kernel-appendix.xml
index 04db02a7a6..962ac0bfb1 100644
--- a/documentation/dev-manual/dev-manual-kernel-appendix.xml
+++ b/documentation/dev-manual/dev-manual-kernel-appendix.xml
@@ -40,7 +40,7 @@
40 <link linkend='poky-extras-repo'><filename>poky-extras</filename></link> 40 <link linkend='poky-extras-repo'><filename>poky-extras</filename></link>
41 Git repository placed within the source directory.</para></listitem> 41 Git repository placed within the source directory.</para></listitem>
42 <listitem><para>A bare clone of the 42 <listitem><para>A bare clone of the
43 <link linkend='local-kernel-files'>Linux Yocto Kernel</link> upstream Git 43 <link linkend='local-kernel-files'>Yocto Project Kernel</link> upstream Git
44 repository to which you want to push your modifications. 44 repository to which you want to push your modifications.
45 </para></listitem> 45 </para></listitem>
46 <listitem><para>A copy of that bare clone in which you make your source 46 <listitem><para>A copy of that bare clone in which you make your source
@@ -83,14 +83,14 @@
83 which is where you make changes that append the kernel build recipes. 83 which is where you make changes that append the kernel build recipes.
84 You edit <filename>.bbappend</filename> files to locate your 84 You edit <filename>.bbappend</filename> files to locate your
85 local kernel source files and to identify the kernel being built. 85 local kernel source files and to identify the kernel being built.
86 This Git repository is a gathering place for extensions to the Linux Yocto 86 This Git repository is a gathering place for extensions to the Yocto Project
87 (or really any) kernel recipes that faciliate the creation and development 87 (or really any) kernel recipes that faciliate the creation and development
88 of kernel features, BSPs or configurations.</para> 88 of kernel features, BSPs or configurations.</para>
89 <para>See the bulleted item 89 <para>See the bulleted item
90 "<link linkend='poky-extras-repo'>The 90 "<link linkend='poky-extras-repo'>The
91 <filename>poky-extras</filename> Git Repository</link>" 91 <filename>poky-extras</filename> Git Repository</link>"
92 for information on how to get these files.</para></listitem> 92 for information on how to get these files.</para></listitem>
93 <listitem><para><emphasis>Bare Clone of the Linux Yocto kernel:</emphasis> 93 <listitem><para><emphasis>Bare Clone of the Yocto Project kernel:</emphasis>
94 This bare Git repository tracks the upstream Git repository of the Linux 94 This bare Git repository tracks the upstream Git repository of the Linux
95 Yocto kernel source code you are changing. 95 Yocto kernel source code you are changing.
96 When you modify the kernel you must work through a bare clone. 96 When you modify the kernel you must work through a bare clone.
@@ -100,15 +100,15 @@
100 <filename>poky-extras</filename> repository points to the bare clone 100 <filename>poky-extras</filename> repository points to the bare clone
101 so that the build process can locate the locally changed source files.</para> 101 so that the build process can locate the locally changed source files.</para>
102 <para>See the bulleted item 102 <para>See the bulleted item
103 "<link linkend='local-kernel-files'>Linux Yocto Kernel</link>" 103 "<link linkend='local-kernel-files'>Yocto Project Kernel</link>"
104 for information on how to set up the bare clone. 104 for information on how to set up the bare clone.
105 </para></listitem> 105 </para></listitem>
106 <listitem><para><emphasis>Copy of the Linux Yocto Kernel Bare Clone:</emphasis> 106 <listitem><para><emphasis>Copy of the Yocto Project Kernel Bare Clone:</emphasis>
107 This Git repository contains the actual source files that you modify. 107 This Git repository contains the actual source files that you modify.
108 Any changes you make to files in this location need to ultimately be pushed 108 Any changes you make to files in this location need to ultimately be pushed
109 to the bare clone using the <filename>git push</filename> command.</para> 109 to the bare clone using the <filename>git push</filename> command.</para>
110 <para>See the bulleted item 110 <para>See the bulleted item
111 "<link linkend='local-kernel-files'>Linux Yocto Kernel</link>" 111 "<link linkend='local-kernel-files'>Yocto Project Kernel</link>"
112 for information on how to set up the bare clone. 112 for information on how to set up the bare clone.
113 <note>Typically, Git workflows follow a scheme where changes made to a local area 113 <note>Typically, Git workflows follow a scheme where changes made to a local area
114 are pulled into a Git repository. 114 are pulled into a Git repository.
@@ -192,7 +192,7 @@
192 Thus, you need to create a bare clone of that kernel and then make a copy of the 192 Thus, you need to create a bare clone of that kernel and then make a copy of the
193 bare clone. 193 bare clone.
194 See the bulleted item 194 See the bulleted item
195 "<link linkend='local-kernel-files'>Linux Yocto Kernel</link>" 195 "<link linkend='local-kernel-files'>Yocto Project Kernel</link>"
196 for information on how to do that. 196 for information on how to do that.
197 </para> 197 </para>
198 198
@@ -708,7 +708,7 @@
708 <para> 708 <para>
709 Once you save the selection, the <filename>.config</filename> configuration file 709 Once you save the selection, the <filename>.config</filename> configuration file
710 is updated. 710 is updated.
711 This is the file that the build system uses to configure the Linux Yocto kernel 711 This is the file that the build system uses to configure the Yocto Project kernel
712 when it is built. 712 when it is built.
713 You can find and examine this file in the build directory. 713 You can find and examine this file in the build directory.
714 This example uses the following: 714 This example uses the following:
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml
index a4120f84db..87e10318a7 100644
--- a/documentation/dev-manual/dev-manual-model.xml
+++ b/documentation/dev-manual/dev-manual-model.xml
@@ -214,7 +214,7 @@
214 <title><anchor id='kernel-spot' />Modifying the Kernel</title> 214 <title><anchor id='kernel-spot' />Modifying the Kernel</title>
215 215
216 <para> 216 <para>
217 Kernel modification involves changing the Linux Yocto kernel, which could involve changing 217 Kernel modification involves changing the Yocto Project kernel, which could involve changing
218 configuration options as well as adding new kernel recipes. 218 configuration options as well as adding new kernel recipes.
219 Configuration changes can be added in the form of configuration fragments, while recipe 219 Configuration changes can be added in the form of configuration fragments, while recipe
220 modification comes through the kernel's <filename>recipes-kernel</filename> area 220 modification comes through the kernel's <filename>recipes-kernel</filename> area
@@ -222,8 +222,8 @@
222 </para> 222 </para>
223 223
224 <para> 224 <para>
225 The remainder of this section presents a high-level overview of the Linux Yocto 225 The remainder of this section presents a high-level overview of the Yocto Project
226 kernel architecture and the steps to modify the Linux Yocto kernel. 226 kernel architecture and the steps to modify the kernel.
227 For a complete discussion of the kernel, see 227 For a complete discussion of the kernel, see
228 <ulink url='&YOCTO_DOCS_KERNEL_URL;'> 228 <ulink url='&YOCTO_DOCS_KERNEL_URL;'>
229 The Yocto Project Kernel Architecture and Use Manual</ulink>. 229 The Yocto Project Kernel Architecture and Use Manual</ulink>.
@@ -244,7 +244,7 @@
244 </para> 244 </para>
245 245
246 <para> 246 <para>
247 You can find a web interface to the Linux Yocto kernel source repositories at 247 You can find a web interface to the Yocto Project kernel source repositories at
248 <ulink url='&YOCTO_GIT_URL;'></ulink>. 248 <ulink url='&YOCTO_GIT_URL;'></ulink>.
249 If you look at the interface, you will see to the left a grouping of 249 If you look at the interface, you will see to the left a grouping of
250 Git repositories titled "Yocto Linux Kernel." 250 Git repositories titled "Yocto Linux Kernel."
@@ -252,17 +252,17 @@
252 the Yocto Project: 252 the Yocto Project:
253 <itemizedlist> 253 <itemizedlist>
254 <listitem><para><emphasis><filename>linux-yocto-2.6.34</filename></emphasis> - The 254 <listitem><para><emphasis><filename>linux-yocto-2.6.34</filename></emphasis> - The
255 stable Linux Yocto kernel that is based on the Linux 2.6.34 release.</para></listitem> 255 stable Yocto Project kernel that is based on the Linux 2.6.34 released kernel.</para></listitem>
256 <listitem><para><emphasis><filename>linux-yocto-2.6.37</filename></emphasis> - The 256 <listitem><para><emphasis><filename>linux-yocto-2.6.37</filename></emphasis> - The
257 stable Linux Yocto kernel that is based on the Linux 2.6.37 release.</para></listitem> 257 stable Yocto Project kernel that is based on the Linux 2.6.37 released kernel.</para></listitem>
258 <listitem><para><emphasis><filename>linux-yocto-3.0</filename></emphasis> - The stable 258 <listitem><para><emphasis><filename>linux-yocto-3.0</filename></emphasis> - The stable
259 Linux Yocto kernel that is based on the Linux 3.0 release.</para></listitem> 259 Yocto Project kernel that is based on the Linux 3.0 released kernel.</para></listitem>
260 <listitem><para><emphasis><filename>linux-yocto-3.0-1.1.x</filename></emphasis> - The 260 <listitem><para><emphasis><filename>linux-yocto-3.0-1.1.x</filename></emphasis> - The
261 stable Linux Yocto kernel to use with the Yocto Project Release 1.1.x. This kernel 261 stable Yocto Project kernel to use with the Yocto Project Release 1.1.x. This kernel
262 is based on the Linux 3.0 release</para></listitem> 262 is based on the Linux 3.0 released kernel.</para></listitem>
263 <listitem><para><emphasis><filename>linux-yocto-3.2</filename></emphasis> - The 263 <listitem><para><emphasis><filename>linux-yocto-3.2</filename></emphasis> - The
264 stable Linux Yocto kernel to use with the Yocto Project Release 1.2. This kernel 264 stable Yocto Project kernel to use with the Yocto Project Release 1.2. This kernel
265 is based on the Linux 3.2 release</para></listitem> 265 is based on the Linux 3.2 released kernel.</para></listitem>
266 <listitem><para><emphasis><filename>linux-yocto-dev</filename></emphasis> - A development 266 <listitem><para><emphasis><filename>linux-yocto-dev</filename></emphasis> - A development
267 kernel based on the latest upstream release candidate available.</para></listitem> 267 kernel based on the latest upstream release candidate available.</para></listitem>
268 </itemizedlist> 268 </itemizedlist>
@@ -304,8 +304,8 @@
304 </para> 304 </para>
305 305
306 <note> 306 <note>
307 Keep in mind the figure does not take into account all the supported Linux Yocto 307 Keep in mind the figure does not take into account all the supported Yocto
308 kernel types, but rather shows a single generic kernel just for conceptual purposes. 308 Project kernel types, but rather shows a single generic kernel just for conceptual purposes.
309 Also keep in mind that this structure represents the Yocto Project source repositories 309 Also keep in mind that this structure represents the Yocto Project source repositories
310 that are either pulled from during the build or established on the host development system 310 that are either pulled from during the build or established on the host development system
311 prior to the build by either cloning a particular kernel's Git repository or by 311 prior to the build by either cloning a particular kernel's Git repository or by
@@ -324,13 +324,13 @@
324 324
325 <para> 325 <para>
326 You make kernel source code available on your host development system by using 326 You make kernel source code available on your host development system by using
327 Git to create a bare clone of the Linux Yocto kernel Git repository 327 Git to create a bare clone of the Yocto Project kernel Git repository
328 in which you are interested. 328 in which you are interested.
329 Then, you use Git again to clone a copy of that bare clone. 329 Then, you use Git again to clone a copy of that bare clone.
330 This copy represents the directory structure on your host system that is particular 330 This copy represents the directory structure on your host system that is particular
331 to the kernel you want. 331 to the kernel you want.
332 These are the files you actually modify to change the kernel. 332 These are the files you actually modify to change the kernel.
333 See the <link linkend='local-kernel-files'>Linux Yocto Kernel</link> item earlier 333 See the <link linkend='local-kernel-files'>Yocto Project Kernel</link> item earlier
334 in this manual for an example of how to set up the kernel source directory 334 in this manual for an example of how to set up the kernel source directory
335 structure on your host system. 335 structure on your host system.
336 </para> 336 </para>
@@ -425,9 +425,9 @@
425 <note>While it is certainly possible to modify the kernel without involving 425 <note>While it is certainly possible to modify the kernel without involving
426 a local Git repository, the suggested workflow for kernel modification 426 a local Git repository, the suggested workflow for kernel modification
427 using the Yocto Project does use a Git repository.</note></para></listitem> 427 using the Yocto Project does use a Git repository.</note></para></listitem>
428 <listitem><para><emphasis>Establish a local copy of the Linux Yocto kernel files on your 428 <listitem><para><emphasis>Establish a local copy of the Yocto Project kernel files on your
429 system</emphasis>: In order to make modifications to the kernel you need two things: 429 system</emphasis>: In order to make modifications to the kernel you need two things:
430 a bare clone of the Linux Yocto kernel you are modifying and 430 a bare clone of the Yocto Project kernel you are modifying and
431 a copy of that bare clone. 431 a copy of that bare clone.
432 The bare clone is required by the build process and is the area to which you 432 The bare clone is required by the build process and is the area to which you
433 push your kernel source changes (pulling does not work with bare clones). 433 push your kernel source changes (pulling does not work with bare clones).
@@ -435,7 +435,7 @@
435 source files. 435 source files.
436 You make your changes to the files in this copy of the bare clone. 436 You make your changes to the files in this copy of the bare clone.
437 For information on how to set these two items up, see the bulleted item 437 For information on how to set these two items up, see the bulleted item
438 "<link linkend='local-kernel-files'>Linux Yocto Kernel</link>" 438 "<link linkend='local-kernel-files'>Yocto Project Kernel</link>"
439 earlier in this manual.</para></listitem> 439 earlier in this manual.</para></listitem>
440 <listitem><para><emphasis>Make changes to the kernel source code if 440 <listitem><para><emphasis>Make changes to the kernel source code if
441 applicable</emphasis>: Modifying the kernel does not always mean directly 441 applicable</emphasis>: Modifying the kernel does not always mean directly
@@ -506,8 +506,8 @@
506 which allows you to distribute the layer.</para></listitem> 506 which allows you to distribute the layer.</para></listitem>
507 <listitem><para><emphasis>If applicable, share your in-tree changes</emphasis>: 507 <listitem><para><emphasis>If applicable, share your in-tree changes</emphasis>:
508 If the changes you made 508 If the changes you made
509 are suited for all Linux Yocto users, you might want to send them on for inclusion 509 are suited for all Yocto Project kernel users, you might want to send them on
510 into the Linux Yocto Git repository. 510 for inclusion into the upstream kernel's Git repository.
511 If the changes are accepted, the Yocto Project Maintainer pulls them into 511 If the changes are accepted, the Yocto Project Maintainer pulls them into
512 the master branch of the kernel tree. 512 the master branch of the kernel tree.
513 Doing so makes them available to everyone using the kernel.</para></listitem> 513 Doing so makes them available to everyone using the kernel.</para></listitem>
@@ -522,7 +522,7 @@
522 522
523 <para> 523 <para>
524 Application development involves creation of an application that you want to be able 524 Application development involves creation of an application that you want to be able
525 to run on your target hardware, which is running a Linux Yocto image. 525 to run on your target hardware, which is running a Yocto Project kernel image.
526 The Yocto Project provides an Application Development Toolkit (ADT) that 526 The Yocto Project provides an Application Development Toolkit (ADT) that
527 facilitates quick development and integration of your application into its run-time environment. 527 facilitates quick development and integration of your application into its run-time environment.
528 Using the ADT you can employ cross-development toolchains designed for your target hardware 528 Using the ADT you can employ cross-development toolchains designed for your target hardware
@@ -567,7 +567,7 @@
567 "<ulink url='&YOCTO_DOCS_QS_URL;#the-linux-distro'>The Linux Distributions</ulink>" and 567 "<ulink url='&YOCTO_DOCS_QS_URL;#the-linux-distro'>The Linux Distributions</ulink>" and
568 "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" sections both 568 "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" sections both
569 in the Yocto Project Quick Start for requirements.</para></listitem> 569 in the Yocto Project Quick Start for requirements.</para></listitem>
570 <listitem><para><emphasis>Secure the Linux Yocto Kernel Target Image</emphasis>: 570 <listitem><para><emphasis>Secure the Yocto Project Kernel Target Image</emphasis>:
571 You must have a target kernel image that has been built using the OpenEmbeded 571 You must have a target kernel image that has been built using the OpenEmbeded
572 build system.</para> 572 build system.</para>
573 <para>Depending on whether the Yocto Project has a pre-built image that matches your target 573 <para>Depending on whether the Yocto Project has a pre-built image that matches your target
@@ -591,7 +591,7 @@
591 See the 591 See the
592 "<link linkend='kernel-modification-workflow'>Kernel Modification Workflow</link>" 592 "<link linkend='kernel-modification-workflow'>Kernel Modification Workflow</link>"
593 section earlier in this manual for information on how to create a modified 593 section earlier in this manual for information on how to create a modified
594 Linux Yocto kernel.</para></listitem> 594 Yocto Project kernel.</para></listitem>
595 </itemizedlist></para> 595 </itemizedlist></para>
596 <para>For information on pre-built kernel image naming schemes for images 596 <para>For information on pre-built kernel image naming schemes for images
597 that can run on the QEMU emulator, see the 597 that can run on the QEMU emulator, see the
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index 15748ebfac..f644ed004f 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -116,13 +116,13 @@
116 wiki page</ulink>, which describes how to create both <filename>poky</filename> 116 wiki page</ulink>, which describes how to create both <filename>poky</filename>
117 and <filename>meta-intel</filename> Git repositories.</para></listitem> 117 and <filename>meta-intel</filename> Git repositories.</para></listitem>
118 </itemizedlist></para></listitem> 118 </itemizedlist></para></listitem>
119 <listitem id='local-kernel-files'><para><emphasis>Linux Yocto Kernel:</emphasis> 119 <listitem id='local-kernel-files'><para><emphasis>Yocto Project Kernel:</emphasis>
120 If you are going to be making modifications to a supported Linux Yocto kernel, you 120 If you are going to be making modifications to a supported Yocto Project kernel, you
121 need to establish local copies of the source. 121 need to establish local copies of the source.
122 You can find Git repositories of supported Linux Yocto Kernels organized under 122 You can find Git repositories of supported Yocto Project Kernels organized under
123 "Yocto Linux Kernel" in the Yocto Project Source Repositories at 123 "Yocto Project Linux Kernel" in the Yocto Project Source Repositories at
124 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.</para> 124 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.</para>
125 <para>This setup involves creating a bare clone of the Linux Yocto kernel and then 125 <para>This setup involves creating a bare clone of the Yocto Project kernel and then
126 copying that cloned repository. 126 copying that cloned repository.
127 You can create the bare clone and the copy of the bare clone anywhere you like. 127 You can create the bare clone and the copy of the bare clone anywhere you like.
128 For simplicity, it is recommended that you create these structures outside of the 128 For simplicity, it is recommended that you create these structures outside of the
@@ -130,7 +130,7 @@
130 <para>As an example, the following transcript shows how to create the bare clone 130 <para>As an example, the following transcript shows how to create the bare clone
131 of the <filename>linux-yocto-3.2</filename> kernel and then create a copy of 131 of the <filename>linux-yocto-3.2</filename> kernel and then create a copy of
132 that clone. 132 that clone.
133 <note>When you have a local Linux Yocto kernel Git repository, you can 133 <note>When you have a local Yocto Project kernel Git repository, you can
134 reference that repository rather than the upstream Git repository as 134 reference that repository rather than the upstream Git repository as
135 part of the <filename>clone</filename> command. 135 part of the <filename>clone</filename> command.
136 Doing so can speed up the process.</note></para> 136 Doing so can speed up the process.</note></para>