diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2017-10-16 11:51:04 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2017-10-30 15:55:05 +0000 |
commit | 29bcd3b38761475278b9ecd2b269d49c07664f7f (patch) | |
tree | 7cd25822fae896d6c7162e9c3af503566a381214 /documentation/kernel-dev | |
parent | b93ebe5d4b67c5a31ac33aa504c2f55554098726 (diff) | |
download | poky-29bcd3b38761475278b9ecd2b269d49c07664f7f.tar.gz |
kernel-dev: Updated dev-manual title
The name of the dev-manual has changed to be the
"Yocto Project Development Tasks Manual". I have updated all the
areas in the kernel-dev manual that reference sections into the
dev-manual.
(From yocto-docs rev: f0309ab658a259637ba7f9301031887114ade988)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/kernel-dev')
-rw-r--r-- | documentation/kernel-dev/kernel-dev-common.xml | 40 | ||||
-rw-r--r-- | documentation/kernel-dev/kernel-dev-faq.xml | 5 | ||||
-rw-r--r-- | documentation/kernel-dev/kernel-dev-intro.xml | 4 |
3 files changed, 26 insertions, 23 deletions
diff --git a/documentation/kernel-dev/kernel-dev-common.xml b/documentation/kernel-dev/kernel-dev-common.xml index 17d89f7454..3b4428549d 100644 --- a/documentation/kernel-dev/kernel-dev-common.xml +++ b/documentation/kernel-dev/kernel-dev-common.xml | |||
@@ -26,14 +26,14 @@ | |||
26 | sure your build host is set up to use the Yocto Project. | 26 | sure your build host is set up to use the Yocto Project. |
27 | For information on how to get set up, see the | 27 | For information on how to get set up, see the |
28 | "<ulink url='&YOCTO_DOCS_DEV_URL;#setting-up-the-development-host-to-use-the-yocto-project'>Setting Up to Use the Yocto Project</ulink>" | 28 | "<ulink url='&YOCTO_DOCS_DEV_URL;#setting-up-the-development-host-to-use-the-yocto-project'>Setting Up to Use the Yocto Project</ulink>" |
29 | section in the Yocto Project Development Manual. | 29 | section in the Yocto Project Development Tasks Manual. |
30 | Part of preparing the system is creating a local Git | 30 | Part of preparing the system is creating a local Git |
31 | repository of the | 31 | repository of the |
32 | <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink> | 32 | <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink> |
33 | (<filename>poky</filename>) on your system. | 33 | (<filename>poky</filename>) on your system. |
34 | Follow the steps in the | 34 | Follow the steps in the |
35 | "<ulink url='&YOCTO_DOCS_DEV_URL;#cloning-the-poky-repository'>Cloning the <filename>poky</filename> Repository</ulink>" | 35 | "<ulink url='&YOCTO_DOCS_DEV_URL;#cloning-the-poky-repository'>Cloning the <filename>poky</filename> Repository</ulink>" |
36 | section in the Yocto Project Development Manual to set up your | 36 | section in the Yocto Project Development Tasks Manual to set up your |
37 | Source Directory. | 37 | Source Directory. |
38 | <note> | 38 | <note> |
39 | Be sure you check out the appropriate development branch or | 39 | Be sure you check out the appropriate development branch or |
@@ -43,7 +43,7 @@ | |||
43 | "<ulink url='&YOCTO_DOCS_DEV_URL;#checking-out-by-branch-in-poky'>Checking Out by Branch in Poky</ulink>" | 43 | "<ulink url='&YOCTO_DOCS_DEV_URL;#checking-out-by-branch-in-poky'>Checking Out by Branch in Poky</ulink>" |
44 | and | 44 | and |
45 | "<ulink url='&YOCTO_DOCS_DEV_URL;#checkout-out-by-tag-in-poky'>Checking Out by Tag in Poky</ulink>" | 45 | "<ulink url='&YOCTO_DOCS_DEV_URL;#checkout-out-by-tag-in-poky'>Checking Out by Tag in Poky</ulink>" |
46 | sections in the Yocto Project Development Manual for more | 46 | sections in the Yocto Project Development Tasks Manual for more |
47 | information. | 47 | information. |
48 | </note> | 48 | </note> |
49 | </para> | 49 | </para> |
@@ -132,15 +132,16 @@ | |||
132 | For background information on working with | 132 | For background information on working with |
133 | common and BSP layers, see the | 133 | common and BSP layers, see the |
134 | "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" | 134 | "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" |
135 | section in the Yocto Project Development Manual | 135 | section in the Yocto Project Development Tasks |
136 | and the | 136 | Manual and the |
137 | "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>" | 137 | "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>" |
138 | section in the Yocto Project Board Support (BSP) | 138 | section in the Yocto Project Board Support (BSP) |
139 | Developer's Guide, respectively. | 139 | Developer's Guide, respectively. |
140 | For information on how to use the | 140 | For information on how to use the |
141 | <filename>yocto-layer</filename> script, see the | 141 | <filename>yocto-layer</filename> script, see the |
142 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-general-layer-using-the-yocto-layer-script'>Creating a General Layer Using the yocto-layer Script</ulink>" | 142 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-general-layer-using-the-yocto-layer-script'>Creating a General Layer Using the yocto-layer Script</ulink>" |
143 | section in the Yocto Project Development Manual. | 143 | section in the Yocto Project Development Tasks |
144 | Manual. | ||
144 | </note> | 145 | </note> |
145 | </para></listitem> | 146 | </para></listitem> |
146 | <listitem><para> | 147 | <listitem><para> |
@@ -292,7 +293,7 @@ | |||
292 | If you need to checkout out the &DISTRO_NAME; branch, | 293 | If you need to checkout out the &DISTRO_NAME; branch, |
293 | see the | 294 | see the |
294 | "<ulink url='&YOCTO_DOCS_DEV_URL;#checking-out-by-branch-in-poky'>Checking out by Branch in Poky</ulink>" | 295 | "<ulink url='&YOCTO_DOCS_DEV_URL;#checking-out-by-branch-in-poky'>Checking out by Branch in Poky</ulink>" |
295 | section in the Yocto Project Development Manual. | 296 | section in the Yocto Project Development Tasks Manual. |
296 | <literallayout class='monospaced'> | 297 | <literallayout class='monospaced'> |
297 | $ cd ~/poky | 298 | $ cd ~/poky |
298 | $ git branch | 299 | $ git branch |
@@ -356,15 +357,16 @@ | |||
356 | For background information on working with | 357 | For background information on working with |
357 | common and BSP layers, see the | 358 | common and BSP layers, see the |
358 | "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" | 359 | "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" |
359 | section in the Yocto Project Development Manual | 360 | section in the Yocto Project Development Tasks |
360 | and the | 361 | Manual and the |
361 | "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>" | 362 | "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>" |
362 | section in the Yocto Project Board Support (BSP) | 363 | section in the Yocto Project Board Support (BSP) |
363 | Developer's Guide, respectively. | 364 | Developer's Guide, respectively. |
364 | For information on how to use the | 365 | For information on how to use the |
365 | <filename>yocto-layer</filename> script, see the | 366 | <filename>yocto-layer</filename> script, see the |
366 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-general-layer-using-the-yocto-layer-script'>Creating a General Layer Using the yocto-layer Script</ulink>" | 367 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-general-layer-using-the-yocto-layer-script'>Creating a General Layer Using the yocto-layer Script</ulink>" |
367 | section in the Yocto Project Development Manual. | 368 | section in the Yocto Project Development Tasks |
369 | Manual. | ||
368 | </note> | 370 | </note> |
369 | </para></listitem> | 371 | </para></listitem> |
370 | <listitem><para> | 372 | <listitem><para> |
@@ -392,7 +394,7 @@ | |||
392 | <para> | 394 | <para> |
393 | For simplicity, it is recommended that you create your | 395 | For simplicity, it is recommended that you create your |
394 | copy of the kernel Git repository outside of the | 396 | copy of the kernel Git repository outside of the |
395 | <ulink url='&YOCTO_DOCS_REF_URL;source-directory'>Source Directory</ulink>, | 397 | <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>, |
396 | which is usually named <filename>poky</filename>. | 398 | which is usually named <filename>poky</filename>. |
397 | Also, be sure you are in the | 399 | Also, be sure you are in the |
398 | <filename>standard/base</filename> branch. | 400 | <filename>standard/base</filename> branch. |
@@ -428,7 +430,7 @@ | |||
428 | Repository:</emphasis> | 430 | Repository:</emphasis> |
429 | For simplicity, it is recommended that you create your | 431 | For simplicity, it is recommended that you create your |
430 | copy of the kernel cache Git repository outside of the | 432 | copy of the kernel cache Git repository outside of the |
431 | <ulink url='&YOCTO_DOCS_REF_URL;source-directory'>Source Directory</ulink>, | 433 | <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>, |
432 | which is usually named <filename>poky</filename>. | 434 | which is usually named <filename>poky</filename>. |
433 | Also, for this example, be sure you are in the | 435 | Also, for this example, be sure you are in the |
434 | <filename>yocto-4.12</filename> branch. | 436 | <filename>yocto-4.12</filename> branch. |
@@ -478,7 +480,7 @@ | |||
478 | patch files. | 480 | patch files. |
479 | For background information on working with layers, see the | 481 | For background information on working with layers, see the |
480 | "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" | 482 | "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" |
481 | section in the Yocto Project Development Manual. | 483 | section in the Yocto Project Development Tasks Manual. |
482 | <note><title>Tip</title> | 484 | <note><title>Tip</title> |
483 | The Yocto Project comes with many tools that simplify | 485 | The Yocto Project comes with many tools that simplify |
484 | tasks you need to perform. | 486 | tasks you need to perform. |
@@ -486,8 +488,8 @@ | |||
486 | script, which simplifies creating a new layer. | 488 | script, which simplifies creating a new layer. |
487 | See the | 489 | See the |
488 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-general-layer-using-the-yocto-layer-script'>Creating a General Layer Using the yocto-layer Script</ulink>" | 490 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-general-layer-using-the-yocto-layer-script'>Creating a General Layer Using the yocto-layer Script</ulink>" |
489 | section in the Yocto Project Development Manual for information | 491 | section in the Yocto Project Development Tasks Manual for |
490 | on how to use this script. | 492 | information on how to use this script. |
491 | </note> | 493 | </note> |
492 | </para> | 494 | </para> |
493 | 495 | ||
@@ -558,7 +560,7 @@ | |||
558 | patch files. | 560 | patch files. |
559 | For more information on using append files, see the | 561 | For more information on using append files, see the |
560 | "<ulink url='&YOCTO_DOCS_DEV_URL;#using-bbappend-files'>Using .bbappend Files in Your Layer</ulink>" | 562 | "<ulink url='&YOCTO_DOCS_DEV_URL;#using-bbappend-files'>Using .bbappend Files in Your Layer</ulink>" |
561 | section in the Yocto Project Development Manual. | 563 | section in the Yocto Project Development Tasks Manual. |
562 | </para></listitem> | 564 | </para></listitem> |
563 | </orderedlist> | 565 | </orderedlist> |
564 | </para> | 566 | </para> |
@@ -573,7 +575,7 @@ | |||
573 | Each release of the Yocto Project provides a few Linux | 575 | Each release of the Yocto Project provides a few Linux |
574 | kernel recipes from which you can choose. | 576 | kernel recipes from which you can choose. |
575 | These are located in the | 577 | These are located in the |
576 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> | 578 | <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink> |
577 | in <filename>meta/recipes-kernel/linux</filename>. | 579 | in <filename>meta/recipes-kernel/linux</filename>. |
578 | </para> | 580 | </para> |
579 | 581 | ||
@@ -694,7 +696,7 @@ | |||
694 | variable could be used to enable features specific to | 696 | variable could be used to enable features specific to |
695 | the kernel. | 697 | the kernel. |
696 | The append file points to specific commits in the | 698 | The append file points to specific commits in the |
697 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> | 699 | <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink> |
698 | Git repository and the <filename>meta</filename> Git repository | 700 | Git repository and the <filename>meta</filename> Git repository |
699 | branches to identify the exact kernel needed to build the | 701 | branches to identify the exact kernel needed to build the |
700 | BSP. | 702 | BSP. |
@@ -1425,7 +1427,7 @@ | |||
1425 | sections. | 1427 | sections. |
1426 | You can also see the | 1428 | You can also see the |
1427 | "<ulink url='&YOCTO_DOCS_DEV_URL;#using-bbappend-files'>Using .bbappend Files in Your Layer"</ulink>" | 1429 | "<ulink url='&YOCTO_DOCS_DEV_URL;#using-bbappend-files'>Using .bbappend Files in Your Layer"</ulink>" |
1428 | section in the Yocto Project Development Manual. | 1430 | section in the Yocto Project Development Tasks Manual. |
1429 | <note> | 1431 | <note> |
1430 | To build <filename>core-image-minimal</filename> | 1432 | To build <filename>core-image-minimal</filename> |
1431 | again and see the effects of your patch, you can | 1433 | again and see the effects of your patch, you can |
diff --git a/documentation/kernel-dev/kernel-dev-faq.xml b/documentation/kernel-dev/kernel-dev-faq.xml index b2cf2d4d0d..c3a20465a0 100644 --- a/documentation/kernel-dev/kernel-dev-faq.xml +++ b/documentation/kernel-dev/kernel-dev-faq.xml | |||
@@ -74,8 +74,9 @@ | |||
74 | include "kernel-image".</para> | 74 | include "kernel-image".</para> |
75 | <para>See the | 75 | <para>See the |
76 | "<ulink url='&YOCTO_DOCS_DEV_URL;#using-bbappend-files'>Using .bbappend Files in Your Layer</ulink>" | 76 | "<ulink url='&YOCTO_DOCS_DEV_URL;#using-bbappend-files'>Using .bbappend Files in Your Layer</ulink>" |
77 | section in the Yocto Project Development Manual for information on | 77 | section in the Yocto Project Development Tasks Manual |
78 | how to use an append file to override metadata. | 78 | for information on how to use an append file to |
79 | override metadata. | ||
79 | </para> | 80 | </para> |
80 | </answer> | 81 | </answer> |
81 | </qandaentry> | 82 | </qandaentry> |
diff --git a/documentation/kernel-dev/kernel-dev-intro.xml b/documentation/kernel-dev/kernel-dev-intro.xml index 94b01593f1..88bc17a444 100644 --- a/documentation/kernel-dev/kernel-dev-intro.xml +++ b/documentation/kernel-dev/kernel-dev-intro.xml | |||
@@ -117,8 +117,8 @@ | |||
117 | </para></listitem> | 117 | </para></listitem> |
118 | <listitem><para> | 118 | <listitem><para> |
119 | The | 119 | The |
120 | "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" section | 120 | "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" |
121 | in the Yocto Project Development Manual | 121 | section in the Yocto Project Development Tasks Manual. |
122 | </para></listitem> | 122 | </para></listitem> |
123 | <listitem><para> | 123 | <listitem><para> |
124 | The | 124 | The |