summaryrefslogtreecommitdiffstats
path: root/documentation/kernel-dev
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/kernel-dev')
-rw-r--r--documentation/kernel-dev/advanced.rst (renamed from documentation/kernel-dev/kernel-dev-advanced.rst)18
-rw-r--r--documentation/kernel-dev/common.rst (renamed from documentation/kernel-dev/kernel-dev-common.rst)48
-rw-r--r--documentation/kernel-dev/concepts-appx.rst (renamed from documentation/kernel-dev/kernel-dev-concepts-appx.rst)14
-rw-r--r--documentation/kernel-dev/faq.rst (renamed from documentation/kernel-dev/kernel-dev-faq.rst)8
-rw-r--r--documentation/kernel-dev/index.rst12
-rw-r--r--documentation/kernel-dev/intro.rst (renamed from documentation/kernel-dev/kernel-dev-intro.rst)16
-rw-r--r--documentation/kernel-dev/maint-appx.rst (renamed from documentation/kernel-dev/kernel-dev-maint-appx.rst)2
7 files changed, 59 insertions, 59 deletions
diff --git a/documentation/kernel-dev/kernel-dev-advanced.rst b/documentation/kernel-dev/advanced.rst
index ddb31edca3..163560b691 100644
--- a/documentation/kernel-dev/kernel-dev-advanced.rst
+++ b/documentation/kernel-dev/advanced.rst
@@ -243,7 +243,7 @@ two files: ``smp.scc`` and ``smp.cfg``. You can find these files in the
243 CONFIG_X86_BIGSMP=y 243 CONFIG_X86_BIGSMP=y
244 244
245You can find general information on configuration 245You can find general information on configuration
246fragment files in the ":ref:`kernel-dev/kernel-dev-common:creating configuration fragments`" section. 246fragment files in the ":ref:`kernel-dev/common:creating configuration fragments`" section.
247 247
248Within the ``smp.scc`` file, the 248Within the ``smp.scc`` file, the
249:term:`KFEATURE_DESCRIPTION` 249:term:`KFEATURE_DESCRIPTION`
@@ -264,7 +264,7 @@ non-hardware fragment.
264 fragment. 264 fragment.
265 265
266As described in the 266As described in the
267":ref:`kernel-dev/kernel-dev-common:validating configuration`" section, you can 267":ref:`kernel-dev/common:validating configuration`" section, you can
268use the following BitBake command to audit your configuration: 268use the following BitBake command to audit your configuration:
269:: 269::
270 270
@@ -325,8 +325,8 @@ for the five patches in the directory.
325 325
326You can create a typical ``.patch`` file using ``diff -Nurp`` or 326You can create a typical ``.patch`` file using ``diff -Nurp`` or
327``git format-patch`` commands. For information on how to create patches, 327``git format-patch`` commands. For information on how to create patches,
328see the ":ref:`kernel-dev/kernel-dev-common:using \`\`devtool\`\` to patch the kernel`" 328see the ":ref:`kernel-dev/common:using \`\`devtool\`\` to patch the kernel`"
329and ":ref:`kernel-dev/kernel-dev-common:using traditional kernel development to patch the kernel`" 329and ":ref:`kernel-dev/common:using traditional kernel development to patch the kernel`"
330sections. 330sections.
331 331
332Features 332Features
@@ -388,7 +388,7 @@ type as follows:
388 You can find kernel recipes in the ``meta/recipes-kernel/linux`` directory 388 You can find kernel recipes in the ``meta/recipes-kernel/linux`` directory
389 of the :ref:`overview-manual/overview-manual-development-environment:yocto project source repositories` 389 of the :ref:`overview-manual/overview-manual-development-environment:yocto project source repositories`
390 (e.g. ``poky/meta/recipes-kernel/linux/linux-yocto_4.12.bb``). See the 390 (e.g. ``poky/meta/recipes-kernel/linux/linux-yocto_4.12.bb``). See the
391 ":ref:`kernel-dev/kernel-dev-advanced:using kernel metadata in a recipe`" 391 ":ref:`kernel-dev/advanced:using kernel metadata in a recipe`"
392 section for more information. 392 section for more information.
393 393
394Three kernel types ("standard", "tiny", and "preempt-rt") are supported 394Three kernel types ("standard", "tiny", and "preempt-rt") are supported
@@ -453,7 +453,7 @@ and ``patch`` commands, respectively.
453 It is not strictly necessary to create a kernel type ``.scc`` 453 It is not strictly necessary to create a kernel type ``.scc``
454 file. The Board Support Package (BSP) file can implicitly define the 454 file. The Board Support Package (BSP) file can implicitly define the
455 kernel type using a ``define`` :term:`KTYPE` ``myktype`` line. See the 455 kernel type using a ``define`` :term:`KTYPE` ``myktype`` line. See the
456 ":ref:`kernel-dev/kernel-dev-advanced:bsp descriptions`" section for more 456 ":ref:`kernel-dev/advanced:bsp descriptions`" section for more
457 information. 457 information.
458 458
459BSP Descriptions 459BSP Descriptions
@@ -555,7 +555,7 @@ You can see that in the BeagleBone example with the following:
555 include beaglebone.scc 555 include beaglebone.scc
556 556
557For information on how to break a complete ``.config`` file into the various 557For information on how to break a complete ``.config`` file into the various
558configuration fragments, see the ":ref:`kernel-dev/kernel-dev-common:creating configuration fragments`" section. 558configuration fragments, see the ":ref:`kernel-dev/common:creating configuration fragments`" section.
559 559
560Finally, if you have any configurations specific to the hardware that 560Finally, if you have any configurations specific to the hardware that
561are not in a ``*.scc`` file, you can include them as follows: 561are not in a ``*.scc`` file, you can include them as follows:
@@ -696,7 +696,7 @@ good approach if you are working with Linux kernel sources you do not
696control or if you just do not want to maintain a Linux kernel Git 696control or if you just do not want to maintain a Linux kernel Git
697repository on your own. For partial information on how you can define 697repository on your own. For partial information on how you can define
698kernel Metadata in the recipe-space, see the 698kernel Metadata in the recipe-space, see the
699":ref:`kernel-dev/kernel-dev-common:modifying an existing recipe`" section. 699":ref:`kernel-dev/common:modifying an existing recipe`" section.
700 700
701Conversely, if you are actively developing a kernel and are already 701Conversely, if you are actively developing a kernel and are already
702maintaining a Linux kernel Git repository of your own, you might find it 702maintaining a Linux kernel Git repository of your own, you might find it
@@ -716,7 +716,7 @@ modifying
716``oe-core/meta-skeleton/recipes-kernel/linux/linux-yocto-custom.bb`` to 716``oe-core/meta-skeleton/recipes-kernel/linux/linux-yocto-custom.bb`` to
717a recipe in your layer, ``FILESEXTRAPATHS`` is typically set to 717a recipe in your layer, ``FILESEXTRAPATHS`` is typically set to
718``${``\ :term:`THISDIR`\ ``}/${``\ :term:`PN`\ ``}``. 718``${``\ :term:`THISDIR`\ ``}/${``\ :term:`PN`\ ``}``.
719See the ":ref:`kernel-dev/kernel-dev-common:modifying an existing recipe`" 719See the ":ref:`kernel-dev/common:modifying an existing recipe`"
720section for more information. 720section for more information.
721 721
722Here is an example that shows a trivial tree of kernel Metadata stored 722Here is an example that shows a trivial tree of kernel Metadata stored
diff --git a/documentation/kernel-dev/kernel-dev-common.rst b/documentation/kernel-dev/common.rst
index 4bb553f8dd..403a63d584 100644
--- a/documentation/kernel-dev/kernel-dev-common.rst
+++ b/documentation/kernel-dev/common.rst
@@ -49,7 +49,7 @@ Getting Ready to Develop Using ``devtool``
49Follow these steps to prepare to update the kernel image using 49Follow these steps to prepare to update the kernel image using
50``devtool``. Completing this procedure leaves you with a clean kernel 50``devtool``. Completing this procedure leaves you with a clean kernel
51image and ready to make modifications as described in the 51image and ready to make modifications as described in the
52":ref:`kernel-dev/kernel-dev-common:using \`\`devtool\`\` to patch the kernel`" 52":ref:`kernel-dev/common:using \`\`devtool\`\` to patch the kernel`"
53section: 53section:
54 54
551. *Initialize the BitBake Environment:* Before building an extensible 551. *Initialize the BitBake Environment:* Before building an extensible
@@ -212,7 +212,7 @@ section:
212 212
213At this point you have set up to start making modifications to the 213At this point you have set up to start making modifications to the
214kernel by using the extensible SDK. For a continued example, see the 214kernel by using the extensible SDK. For a continued example, see the
215":ref:`kernel-dev/kernel-dev-common:using \`\`devtool\`\` to patch the kernel`" 215":ref:`kernel-dev/common:using \`\`devtool\`\` to patch the kernel`"
216section. 216section.
217 217
218Getting Ready for Traditional Kernel Development 218Getting Ready for Traditional Kernel Development
@@ -226,7 +226,7 @@ you will be editing these files.
226Follow these steps to prepare to update the kernel image using 226Follow these steps to prepare to update the kernel image using
227traditional kernel development flow with the Yocto Project. Completing 227traditional kernel development flow with the Yocto Project. Completing
228this procedure leaves you ready to make modifications to the kernel 228this procedure leaves you ready to make modifications to the kernel
229source as described in the ":ref:`kernel-dev/kernel-dev-common:using traditional kernel development to patch the kernel`" 229source as described in the ":ref:`kernel-dev/common:using traditional kernel development to patch the kernel`"
230section: 230section:
231 231
2321. *Initialize the BitBake Environment:* Before you can do anything 2321. *Initialize the BitBake Environment:* Before you can do anything
@@ -457,11 +457,11 @@ the :term:`Source Directory` in
457 457
458Modifying an existing recipe can consist of the following: 458Modifying an existing recipe can consist of the following:
459 459
460- :ref:`kernel-dev/kernel-dev-common:creating the append file` 460- :ref:`kernel-dev/common:creating the append file`
461 461
462- :ref:`kernel-dev/kernel-dev-common:applying patches` 462- :ref:`kernel-dev/common:applying patches`
463 463
464- :ref:`kernel-dev/kernel-dev-common:changing the configuration` 464- :ref:`kernel-dev/common:changing the configuration`
465 465
466Before modifying an existing recipe, be sure that you have created a 466Before modifying an existing recipe, be sure that you have created a
467minimal, custom layer from which you can work. See the "`Creating and 467minimal, custom layer from which you can work. See the "`Creating and
@@ -642,9 +642,9 @@ and applies the patches before building the kernel.
642 642
643For a detailed example showing how to patch the kernel using 643For a detailed example showing how to patch the kernel using
644``devtool``, see the 644``devtool``, see the
645":ref:`kernel-dev/kernel-dev-common:using \`\`devtool\`\` to patch the kernel`" 645":ref:`kernel-dev/common:using \`\`devtool\`\` to patch the kernel`"
646and 646and
647":ref:`kernel-dev/kernel-dev-common:using traditional kernel development to patch the kernel`" 647":ref:`kernel-dev/common:using traditional kernel development to patch the kernel`"
648sections. 648sections.
649 649
650Changing the Configuration 650Changing the Configuration
@@ -769,7 +769,7 @@ the extensible SDK and ``devtool``.
769 769
770 Before attempting this procedure, be sure you have performed the 770 Before attempting this procedure, be sure you have performed the
771 steps to get ready for updating the kernel as described in the 771 steps to get ready for updating the kernel as described in the
772 ":ref:`kernel-dev/kernel-dev-common:getting ready to develop using \`\`devtool\`\``" 772 ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``"
773 section. 773 section.
774 774
775Patching the kernel involves changing or adding configurations to an 775Patching the kernel involves changing or adding configurations to an
@@ -782,7 +782,7 @@ output at boot time through ``printk`` statements in the kernel's
782``calibrate.c`` source code file. Applying the patch and booting the 782``calibrate.c`` source code file. Applying the patch and booting the
783modified image causes the added messages to appear on the emulator's 783modified image causes the added messages to appear on the emulator's
784console. The example is a continuation of the setup procedure found in 784console. The example is a continuation of the setup procedure found in
785the ":ref:`kernel-dev/kernel-dev-common:getting ready to develop using \`\`devtool\`\``" Section. 785the ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" Section.
786 786
7871. *Check Out the Kernel Source Files:* First you must use ``devtool`` 7871. *Check Out the Kernel Source Files:* First you must use ``devtool``
788 to checkout the kernel source code in its workspace. Be sure you are 788 to checkout the kernel source code in its workspace. Be sure you are
@@ -791,7 +791,7 @@ the ":ref:`kernel-dev/kernel-dev-common:getting ready to develop using \`\`devto
791 .. note:: 791 .. note::
792 792
793 See this step in the 793 See this step in the
794 ":ref:`kernel-dev/kernel-dev-common:getting ready to develop using \`\`devtool\`\``" 794 ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``"
795 section for more information. 795 section for more information.
796 796
797 Use the following ``devtool`` command to check out the code: 797 Use the following ``devtool`` command to check out the code:
@@ -912,7 +912,7 @@ the ":ref:`kernel-dev/kernel-dev-common:getting ready to develop using \`\`devto
912 .. note:: 912 .. note::
913 913
914 See Step 3 of the 914 See Step 3 of the
915 ":ref:`kernel-dev/kernel-dev-common:getting ready to develop using \`\`devtool\`\``" 915 ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``"
916 section for information on setting up this layer. 916 section for information on setting up this layer.
917 917
918 Once the command 918 Once the command
@@ -935,14 +935,14 @@ Using Traditional Kernel Development to Patch the Kernel
935The steps in this procedure show you how you can patch the kernel using 935The steps in this procedure show you how you can patch the kernel using
936traditional kernel development (i.e. not using ``devtool`` and the 936traditional kernel development (i.e. not using ``devtool`` and the
937extensible SDK as described in the 937extensible SDK as described in the
938":ref:`kernel-dev/kernel-dev-common:using \`\`devtool\`\` to patch the kernel`" 938":ref:`kernel-dev/common:using \`\`devtool\`\` to patch the kernel`"
939section). 939section).
940 940
941.. note:: 941.. note::
942 942
943 Before attempting this procedure, be sure you have performed the 943 Before attempting this procedure, be sure you have performed the
944 steps to get ready for updating the kernel as described in the 944 steps to get ready for updating the kernel as described in the
945 ":ref:`kernel-dev/kernel-dev-common:getting ready for traditional kernel development`" 945 ":ref:`kernel-dev/common:getting ready for traditional kernel development`"
946 section. 946 section.
947 947
948Patching the kernel involves changing or adding configurations to an 948Patching the kernel involves changing or adding configurations to an
@@ -1190,9 +1190,9 @@ the tool and save your changes to create an updated version of the
1190 1190
1191 You can use the entire ``.config`` file as the ``defconfig`` file. For 1191 You can use the entire ``.config`` file as the ``defconfig`` file. For
1192 information on ``defconfig`` files, see the 1192 information on ``defconfig`` files, see the
1193 ":ref:`kernel-dev/kernel-dev-common:changing the configuration`", 1193 ":ref:`kernel-dev/common:changing the configuration`",
1194 ":ref:`kernel-dev/kernel-dev-common:using an "in-tree" \`\`defconfig\`\` file`", 1194 ":ref:`kernel-dev/common:using an "in-tree" \`\`defconfig\`\` file`",
1195 and ":ref:`kernel-dev/kernel-dev-common:creating a \`\`defconfig\`\` file`" 1195 and ":ref:`kernel-dev/common:creating a \`\`defconfig\`\` file`"
1196 sections. 1196 sections.
1197 1197
1198Consider an example that configures the "CONFIG_SMP" setting for the 1198Consider an example that configures the "CONFIG_SMP" setting for the
@@ -1320,7 +1320,7 @@ appear in the ``.config`` file, which is in the :term:`Build Directory`.
1320 1320
1321 For more information about where the ``.config`` file is located, see the 1321 For more information about where the ``.config`` file is located, see the
1322 example in the 1322 example in the
1323 ":ref:`kernel-dev/kernel-dev-common:using \`\`menuconfig\`\``" 1323 ":ref:`kernel-dev/common:using \`\`menuconfig\`\``"
1324 section. 1324 section.
1325 1325
1326It is simple to create a configuration fragment. One method is to use 1326It is simple to create a configuration fragment. One method is to use
@@ -1377,7 +1377,7 @@ information on how to use the output as a configuration fragment.
1377.. note:: 1377.. note::
1378 1378
1379 You can also use this method to create configuration fragments for a 1379 You can also use this method to create configuration fragments for a
1380 BSP. See the ":ref:`kernel-dev/kernel-dev-advanced:bsp descriptions`" 1380 BSP. See the ":ref:`kernel-dev/advanced:bsp descriptions`"
1381 section for more information. 1381 section for more information.
1382 1382
1383Where do you put your configuration fragment files? You can place these 1383Where do you put your configuration fragment files? You can place these
@@ -1423,7 +1423,7 @@ when you override a policy configuration in a hardware configuration
1423fragment. 1423fragment.
1424 1424
1425In order to run this task, you must have an existing ``.config`` file. 1425In order to run this task, you must have an existing ``.config`` file.
1426See the ":ref:`kernel-dev/kernel-dev-common:using \`\`menuconfig\`\``" section for 1426See the ":ref:`kernel-dev/common:using \`\`menuconfig\`\``" section for
1427information on how to create a configuration file. 1427information on how to create a configuration file.
1428 1428
1429Following is sample output from the ``do_kernel_configcheck`` task: 1429Following is sample output from the ``do_kernel_configcheck`` task:
@@ -1496,7 +1496,7 @@ and
1496tasks until they produce no warnings. 1496tasks until they produce no warnings.
1497 1497
1498For more information on how to use the ``menuconfig`` tool, see the 1498For more information on how to use the ``menuconfig`` tool, see the
1499:ref:`kernel-dev/kernel-dev-common:using \`\`menuconfig\`\`` section. 1499:ref:`kernel-dev/common:using \`\`menuconfig\`\`` section.
1500 1500
1501Fine-Tuning the Kernel Configuration File 1501Fine-Tuning the Kernel Configuration File
1502----------------------------------------- 1502-----------------------------------------
@@ -1612,7 +1612,7 @@ source directory. Follow these steps to clean up the version string:
1612 Depending on your particular kernel development workflow, the 1612 Depending on your particular kernel development workflow, the
1613 commands you use to rebuild the kernel might differ. For information 1613 commands you use to rebuild the kernel might differ. For information
1614 on building the kernel image when using ``devtool``, see the 1614 on building the kernel image when using ``devtool``, see the
1615 ":ref:`kernel-dev/kernel-dev-common:using \`\`devtool\`\` to patch the kernel`" 1615 ":ref:`kernel-dev/common:using \`\`devtool\`\` to patch the kernel`"
1616 section. For 1616 section. For
1617 information on building the kernel image when using Bitbake, see the 1617 information on building the kernel image when using Bitbake, see the
1618 "`Using Traditional Kernel Development to Patch the 1618 "`Using Traditional Kernel Development to Patch the
@@ -1942,7 +1942,7 @@ Adding Recipe-Space Kernel Features
1942=================================== 1942===================================
1943 1943
1944You can add kernel features in the 1944You can add kernel features in the
1945:ref:`recipe-space <kernel-dev/kernel-dev-advanced:recipe-space metadata>` 1945:ref:`recipe-space <kernel-dev/advanced:recipe-space metadata>`
1946by using the :term:`KERNEL_FEATURES` 1946by using the :term:`KERNEL_FEATURES`
1947variable and by specifying the feature's ``.scc`` file path in the 1947variable and by specifying the feature's ``.scc`` file path in the
1948:term:`SRC_URI` statement. When you 1948:term:`SRC_URI` statement. When you
@@ -1961,7 +1961,7 @@ OpenEmbedded build system searches all forms of kernel Metadata on the
1961``SRC_URI`` statement regardless of whether the Metadata is in the 1961``SRC_URI`` statement regardless of whether the Metadata is in the
1962"kernel-cache", system kernel Metadata, or a recipe-space Metadata (i.e. 1962"kernel-cache", system kernel Metadata, or a recipe-space Metadata (i.e.
1963part of the kernel recipe). See the 1963part of the kernel recipe). See the
1964":ref:`kernel-dev/kernel-dev-advanced:kernel metadata location`" section for 1964":ref:`kernel-dev/advanced:kernel metadata location`" section for
1965additional information. 1965additional information.
1966 1966
1967When you specify the feature's ``.scc`` file on the ``SRC_URI`` 1967When you specify the feature's ``.scc`` file on the ``SRC_URI``
diff --git a/documentation/kernel-dev/kernel-dev-concepts-appx.rst b/documentation/kernel-dev/concepts-appx.rst
index 470d6ce1c3..865f6d8bef 100644
--- a/documentation/kernel-dev/kernel-dev-concepts-appx.rst
+++ b/documentation/kernel-dev/concepts-appx.rst
@@ -71,7 +71,7 @@ and included with Yocto Project releases:
71 and configurations for the linux-yocto kernel tree. This repository 71 and configurations for the linux-yocto kernel tree. This repository
72 is useful when working on the linux-yocto kernel. For more 72 is useful when working on the linux-yocto kernel. For more
73 information on this "Advanced Kernel Metadata", see the 73 information on this "Advanced Kernel Metadata", see the
74 ":doc:`kernel-dev-advanced`" Chapter. 74 ":doc:`/kernel-dev/advanced`" Chapter.
75 75
76- *linux-yocto-dev:* A development kernel based on the latest 76- *linux-yocto-dev:* A development kernel based on the latest
77 upstream release candidate available. 77 upstream release candidate available.
@@ -293,13 +293,13 @@ ways:
293 293
294- *Files Accessed While using devtool:* ``devtool``, which is 294- *Files Accessed While using devtool:* ``devtool``, which is
295 available with the Yocto Project, is the preferred method by which to 295 available with the Yocto Project, is the preferred method by which to
296 modify the kernel. See the ":ref:`kernel-dev/kernel-dev-intro:kernel modification workflow`" section. 296 modify the kernel. See the ":ref:`kernel-dev/intro:kernel modification workflow`" section.
297 297
298- *Cloned Repository:* If you are working in the kernel all the time, 298- *Cloned Repository:* If you are working in the kernel all the time,
299 you probably would want to set up your own local Git repository of 299 you probably would want to set up your own local Git repository of
300 the Yocto Linux kernel tree. For information on how to clone a Yocto 300 the Yocto Linux kernel tree. For information on how to clone a Yocto
301 Linux kernel Git repository, see the 301 Linux kernel Git repository, see the
302 ":ref:`kernel-dev/kernel-dev-common:preparing the build host to work on the kernel`" 302 ":ref:`kernel-dev/common:preparing the build host to work on the kernel`"
303 section. 303 section.
304 304
305- *Temporary Source Files from a Build:* If you just need to make some 305- *Temporary Source Files from a Build:* If you just need to make some
@@ -327,11 +327,11 @@ source files used during the build.
327 327
328Again, for additional information on the Yocto Project kernel's 328Again, for additional information on the Yocto Project kernel's
329architecture and its branching strategy, see the 329architecture and its branching strategy, see the
330":ref:`kernel-dev/kernel-dev-concepts-appx:yocto linux kernel architecture and branching strategies`" 330":ref:`kernel-dev/concepts-appx:yocto linux kernel architecture and branching strategies`"
331section. You can also reference the 331section. You can also reference the
332":ref:`kernel-dev/kernel-dev-common:using \`\`devtool\`\` to patch the kernel`" 332":ref:`kernel-dev/common:using \`\`devtool\`\` to patch the kernel`"
333and 333and
334":ref:`kernel-dev/kernel-dev-common:using traditional kernel development to patch the kernel`" 334":ref:`kernel-dev/common:using traditional kernel development to patch the kernel`"
335sections for detailed example that modifies the kernel. 335sections for detailed example that modifies the kernel.
336 336
337Determining Hardware and Non-Hardware Features for the Kernel Configuration Audit Phase 337Determining Hardware and Non-Hardware Features for the Kernel Configuration Audit Phase
@@ -341,7 +341,7 @@ This section describes part of the kernel configuration audit phase that
341most developers can ignore. For general information on kernel 341most developers can ignore. For general information on kernel
342configuration including ``menuconfig``, ``defconfig`` files, and 342configuration including ``menuconfig``, ``defconfig`` files, and
343configuration fragments, see the 343configuration fragments, see the
344":ref:`kernel-dev/kernel-dev-common:configuring the kernel`" section. 344":ref:`kernel-dev/common:configuring the kernel`" section.
345 345
346During this part of the audit phase, the contents of the final 346During this part of the audit phase, the contents of the final
347``.config`` file are compared against the fragments specified by the 347``.config`` file are compared against the fragments specified by the
diff --git a/documentation/kernel-dev/kernel-dev-faq.rst b/documentation/kernel-dev/faq.rst
index 54623453a4..c2106f81e1 100644
--- a/documentation/kernel-dev/kernel-dev-faq.rst
+++ b/documentation/kernel-dev/faq.rst
@@ -13,21 +13,21 @@ How do I use my own Linux kernel ``.config`` file?
13-------------------------------------------------- 13--------------------------------------------------
14 14
15Refer to the 15Refer to the
16":ref:`kernel-dev/kernel-dev-common:changing the configuration`" 16":ref:`kernel-dev/common:changing the configuration`"
17section for information. 17section for information.
18 18
19How do I create configuration fragments? 19How do I create configuration fragments?
20---------------------------------------- 20----------------------------------------
21 21
22A: Refer to the 22A: Refer to the
23":ref:`kernel-dev/kernel-dev-common:creating configuration fragments`" 23":ref:`kernel-dev/common:creating configuration fragments`"
24section for information. 24section for information.
25 25
26How do I use my own Linux kernel sources? 26How do I use my own Linux kernel sources?
27----------------------------------------- 27-----------------------------------------
28 28
29Refer to the 29Refer to the
30":ref:`kernel-dev/kernel-dev-common:working with your own sources`" 30":ref:`kernel-dev/common:working with your own sources`"
31section for information. 31section for information.
32 32
33How do I install/not-install the kernel image on the rootfs? 33How do I install/not-install the kernel image on the rootfs?
@@ -63,7 +63,7 @@ machine:
63 MACHINE_EXTRA_RRECOMMENDS += "kernel-module-ab123" 63 MACHINE_EXTRA_RRECOMMENDS += "kernel-module-ab123"
64 64
65For more information, see the 65For more information, see the
66":ref:`kernel-dev/kernel-dev-common:incorporating out-of-tree modules`" section. 66":ref:`kernel-dev/common:incorporating out-of-tree modules`" section.
67 67
68How do I change the Linux kernel command line? 68How do I change the Linux kernel command line?
69---------------------------------------------- 69----------------------------------------------
diff --git a/documentation/kernel-dev/index.rst b/documentation/kernel-dev/index.rst
index 55b42ed992..a8848ec8cc 100644
--- a/documentation/kernel-dev/index.rst
+++ b/documentation/kernel-dev/index.rst
@@ -10,12 +10,12 @@ Yocto Project Linux Kernel Development Manual
10 :caption: Table of Contents 10 :caption: Table of Contents
11 :numbered: 11 :numbered:
12 12
13 kernel-dev-intro 13 intro
14 kernel-dev-common 14 common
15 kernel-dev-advanced 15 advanced
16 kernel-dev-concepts-appx 16 concepts-appx
17 kernel-dev-maint-appx 17 maint-appx
18 kernel-dev-faq 18 faq
19 history 19 history
20 20
21.. include:: /boilerplate.rst 21.. include:: /boilerplate.rst
diff --git a/documentation/kernel-dev/kernel-dev-intro.rst b/documentation/kernel-dev/intro.rst
index 3987b0e59d..2b60616df4 100644
--- a/documentation/kernel-dev/kernel-dev-intro.rst
+++ b/documentation/kernel-dev/intro.rst
@@ -27,7 +27,7 @@ and supported for at least one additional Yocto Project release. As they
27align, these previous releases are updated to include the latest from 27align, these previous releases are updated to include the latest from
28the Long Term Support Initiative (LTSI) project. You can learn more 28the Long Term Support Initiative (LTSI) project. You can learn more
29about Yocto Linux kernels and LTSI in the 29about Yocto Linux kernels and LTSI in the
30":ref:`kernel-dev/kernel-dev-concepts-appx:yocto project kernel development and maintenance`" section. 30":ref:`kernel-dev/concepts-appx:yocto project kernel development and maintenance`" section.
31 31
32Also included is a Yocto Linux kernel development recipe 32Also included is a Yocto Linux kernel development recipe
33(``linux-yocto-dev.bb``) should you want to work with the very latest in 33(``linux-yocto-dev.bb``) should you want to work with the very latest in
@@ -36,7 +36,7 @@ upstream Yocto Linux kernel development and kernel Metadata development.
36.. note:: 36.. note::
37 37
38 For more on Yocto Linux kernels, see the 38 For more on Yocto Linux kernels, see the
39 ":ref:`kernel-dev/kernel-dev-concepts-appx:yocto project kernel development and maintenance`" 39 ":ref:`kernel-dev/concepts-appx:yocto project kernel development and maintenance`"
40 section. 40 section.
41 41
42The Yocto Project also provides a powerful set of kernel tools for 42The Yocto Project also provides a powerful set of kernel tools for
@@ -124,13 +124,13 @@ general information and references for further information.
124 Using ``devtool`` and the eSDK requires that you have a clean build 124 Using ``devtool`` and the eSDK requires that you have a clean build
125 of the image and that you are set up with the appropriate eSDK. For 125 of the image and that you are set up with the appropriate eSDK. For
126 more information, see the 126 more information, see the
127 ":ref:`kernel-dev/kernel-dev-common:getting ready to develop using \`\`devtool\`\``" 127 ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``"
128 section. 128 section.
129 129
130 Using traditional kernel development requires that you have the 130 Using traditional kernel development requires that you have the
131 kernel source available in an isolated local Git repository. For more 131 kernel source available in an isolated local Git repository. For more
132 information, see the 132 information, see the
133 ":ref:`kernel-dev/kernel-dev-common:getting ready for traditional kernel development`" 133 ":ref:`kernel-dev/common:getting ready for traditional kernel development`"
134 section. 134 section.
135 135
1363. *Make Changes to the Kernel Source Code if applicable:* Modifying the 1363. *Make Changes to the Kernel Source Code if applicable:* Modifying the
@@ -138,17 +138,17 @@ general information and references for further information.
138 if you have to do this, you make the changes to the files in the 138 if you have to do this, you make the changes to the files in the
139 eSDK's Build Directory if you are using ``devtool``. For more 139 eSDK's Build Directory if you are using ``devtool``. For more
140 information, see the 140 information, see the
141 ":ref:`kernel-dev/kernel-dev-common:using \`\`devtool\`\` to patch the kernel`" 141 ":ref:`kernel-dev/common:using \`\`devtool\`\` to patch the kernel`"
142 section. 142 section.
143 143
144 If you are using traditional kernel development, you edit the source 144 If you are using traditional kernel development, you edit the source
145 files in the kernel's local Git repository. For more information, see the 145 files in the kernel's local Git repository. For more information, see the
146 ":ref:`kernel-dev/kernel-dev-common:using traditional kernel development to patch the kernel`" 146 ":ref:`kernel-dev/common:using traditional kernel development to patch the kernel`"
147 section. 147 section.
148 148
1494. *Make Kernel Configuration Changes if Applicable:* If your situation 1494. *Make Kernel Configuration Changes if Applicable:* If your situation
150 calls for changing the kernel's configuration, you can use 150 calls for changing the kernel's configuration, you can use
151 :ref:`menuconfig <kernel-dev/kernel-dev-common:using \`\`menuconfig\`\`>`, 151 :ref:`menuconfig <kernel-dev/common:using \`\`menuconfig\`\`>`,
152 which allows you to 152 which allows you to
153 interactively develop and test the configuration changes you are 153 interactively develop and test the configuration changes you are
154 making to the kernel. Saving changes you make with ``menuconfig`` 154 making to the kernel. Saving changes you make with ``menuconfig``
@@ -165,7 +165,7 @@ general information and references for further information.
165 ``menuconfig`` and you have saved them, you can directly compare the 165 ``menuconfig`` and you have saved them, you can directly compare the
166 resulting ``.config`` file against an existing original and gather 166 resulting ``.config`` file against an existing original and gather
167 those changes into a 167 those changes into a
168 :ref:`configuration fragment file <kernel-dev/kernel-dev-common:creating configuration fragments>` to be 168 :ref:`configuration fragment file <kernel-dev/common:creating configuration fragments>` to be
169 referenced from within the kernel's ``.bbappend`` file. 169 referenced from within the kernel's ``.bbappend`` file.
170 170
171 Additionally, if you are working in a BSP layer and need to modify 171 Additionally, if you are working in a BSP layer and need to modify
diff --git a/documentation/kernel-dev/kernel-dev-maint-appx.rst b/documentation/kernel-dev/maint-appx.rst
index ec1c0ac03d..89f4b43343 100644
--- a/documentation/kernel-dev/kernel-dev-maint-appx.rst
+++ b/documentation/kernel-dev/maint-appx.rst
@@ -37,7 +37,7 @@ kernel that branches off ``linux.org`` version 4.12 and the
37For more information on 37For more information on
38how to set up a local Git repository of the Yocto Project Linux kernel 38how to set up a local Git repository of the Yocto Project Linux kernel
39files, see the 39files, see the
40":ref:`kernel-dev/kernel-dev-common:preparing the build host to work on the kernel`" 40":ref:`kernel-dev/common:preparing the build host to work on the kernel`"
41section. 41section.
42 42
43Once you have cloned the kernel Git repository and the cache of Metadata 43Once you have cloned the kernel Git repository and the cache of Metadata