diff options
Diffstat (limited to 'poky/documentation/kernel-dev')
| -rw-r--r-- | poky/documentation/kernel-dev/advanced.rst (renamed from poky/documentation/kernel-dev/kernel-dev-advanced.rst) | 30 | ||||
| -rw-r--r-- | poky/documentation/kernel-dev/common.rst (renamed from poky/documentation/kernel-dev/kernel-dev-common.rst) | 90 | ||||
| -rw-r--r-- | poky/documentation/kernel-dev/concepts-appx.rst (renamed from poky/documentation/kernel-dev/kernel-dev-concepts-appx.rst) | 20 | ||||
| -rw-r--r-- | poky/documentation/kernel-dev/faq.rst (renamed from poky/documentation/kernel-dev/kernel-dev-faq.rst) | 10 | ||||
| -rw-r--r-- | poky/documentation/kernel-dev/index.rst (renamed from poky/documentation/kernel-dev/kernel-dev.rst) | 12 | ||||
| -rw-r--r-- | poky/documentation/kernel-dev/intro.rst (renamed from poky/documentation/kernel-dev/kernel-dev-intro.rst) | 26 | ||||
| -rw-r--r-- | poky/documentation/kernel-dev/maint-appx.rst (renamed from poky/documentation/kernel-dev/kernel-dev-maint-appx.rst) | 6 |
7 files changed, 97 insertions, 97 deletions
diff --git a/poky/documentation/kernel-dev/kernel-dev-advanced.rst b/poky/documentation/kernel-dev/advanced.rst index ca049316e..dd0b76bc3 100644 --- a/poky/documentation/kernel-dev/kernel-dev-advanced.rst +++ b/poky/documentation/kernel-dev/advanced.rst @@ -16,7 +16,7 @@ complexity of the configuration and sources used to support multiple BSPs and Linux kernel types. Kernel Metadata exists in many places. One area in the -:ref:`overview-manual/overview-manual-development-environment:yocto project source repositories` +:ref:`overview-manual/development-environment:yocto project source repositories` is the ``yocto-kernel-cache`` Git repository. You can find this repository grouped under the "Yocto Linux Kernel" heading in the :yocto_git:`Yocto Project Source Repositories <>`. @@ -200,7 +200,7 @@ either :term:`FILESEXTRAPATHS` if you are creating Metadata in `recipe-space <#recipe-space-metadata>`__, or the top level of -:yocto_git:`yocto-kernel-cache </cgit/cgit.cgi/yocto-kernel-cache/tree/>` +:yocto_git:`yocto-kernel-cache </yocto-kernel-cache/tree/>` if you are creating `Metadata outside of the recipe-space <#metadata-outside-the-recipe-space>`__. @@ -243,7 +243,7 @@ two files: ``smp.scc`` and ``smp.cfg``. You can find these files in the CONFIG_X86_BIGSMP=y You can find general information on configuration -fragment files in the ":ref:`kernel-dev/kernel-dev-common:creating configuration fragments`" section. +fragment files in the ":ref:`kernel-dev/common:creating configuration fragments`" section. Within the ``smp.scc`` file, the :term:`KFEATURE_DESCRIPTION` @@ -264,7 +264,7 @@ non-hardware fragment. fragment. As described in the -":ref:`kernel-dev/kernel-dev-common:validating configuration`" section, you can +":ref:`kernel-dev/common:validating configuration`" section, you can use the following BitBake command to audit your configuration: :: @@ -325,8 +325,8 @@ for the five patches in the directory. You can create a typical ``.patch`` file using ``diff -Nurp`` or ``git format-patch`` commands. For information on how to create patches, -see the ":ref:`kernel-dev/kernel-dev-common:using \`\`devtool\`\` to patch the kernel`" -and ":ref:`kernel-dev/kernel-dev-common:using traditional kernel development to patch the kernel`" +see the ":ref:`kernel-dev/common:using \`\`devtool\`\` to patch the kernel`" +and ":ref:`kernel-dev/common:using traditional kernel development to patch the kernel`" sections. Features @@ -369,7 +369,7 @@ in the "`Features <#features>`__" section. The variable in the kernel recipe selects the kernel type. For example, in the ``linux-yocto_4.12.bb`` kernel recipe found in ``poky/meta/recipes-kernel/linux``, a -:ref:`require <bitbake:require-inclusion>` directive +:ref:`require <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:\`\`require\`\` directive>` directive includes the ``poky/meta/recipes-kernel/linux/linux-yocto.inc`` file, which has the following statement that defines the default kernel type: :: @@ -386,9 +386,9 @@ type as follows: .. note:: You can find kernel recipes in the ``meta/recipes-kernel/linux`` directory - of the :ref:`overview-manual/overview-manual-development-environment:yocto project source repositories` + of the :ref:`overview-manual/development-environment:yocto project source repositories` (e.g. ``poky/meta/recipes-kernel/linux/linux-yocto_4.12.bb``). See the - ":ref:`kernel-dev/kernel-dev-advanced:using kernel metadata in a recipe`" + ":ref:`kernel-dev/advanced:using kernel metadata in a recipe`" section for more information. Three kernel types ("standard", "tiny", and "preempt-rt") are supported @@ -453,7 +453,7 @@ and ``patch`` commands, respectively. It is not strictly necessary to create a kernel type ``.scc`` file. The Board Support Package (BSP) file can implicitly define the kernel type using a ``define`` :term:`KTYPE` ``myktype`` line. See the - ":ref:`kernel-dev/kernel-dev-advanced:bsp descriptions`" section for more + ":ref:`kernel-dev/advanced:bsp descriptions`" section for more information. BSP Descriptions @@ -469,12 +469,12 @@ supported kernel type. For BSPs supported by the Yocto Project, the BSP description files are located in the ``bsp`` directory of the ``yocto-kernel-cache`` repository organized under the "Yocto Linux Kernel" heading in the - :yocto_git:`Yocto Project Source Repositories </>`. + :yocto_git:`Yocto Project Source Repositories <>`. This section overviews the BSP description structure, the aggregation concepts, and presents a detailed example using a BSP supported by the Yocto Project (i.e. BeagleBone Board). For complete information on BSP -layer file hierarchy, see the :doc:`../bsp-guide/bsp-guide`. +layer file hierarchy, see the :doc:`/bsp-guide/index`. Description Overview ~~~~~~~~~~~~~~~~~~~~ @@ -555,7 +555,7 @@ You can see that in the BeagleBone example with the following: include beaglebone.scc For information on how to break a complete ``.config`` file into the various -configuration fragments, see the ":ref:`kernel-dev/kernel-dev-common:creating configuration fragments`" section. +configuration fragments, see the ":ref:`kernel-dev/common:creating configuration fragments`" section. Finally, if you have any configurations specific to the hardware that are 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 control or if you just do not want to maintain a Linux kernel Git repository on your own. For partial information on how you can define kernel Metadata in the recipe-space, see the -":ref:`kernel-dev/kernel-dev-common:modifying an existing recipe`" section. +":ref:`kernel-dev/common:modifying an existing recipe`" section. Conversely, if you are actively developing a kernel and are already maintaining a Linux kernel Git repository of your own, you might find it @@ -716,7 +716,7 @@ modifying ``oe-core/meta-skeleton/recipes-kernel/linux/linux-yocto-custom.bb`` to a recipe in your layer, ``FILESEXTRAPATHS`` is typically set to ``${``\ :term:`THISDIR`\ ``}/${``\ :term:`PN`\ ``}``. -See the ":ref:`kernel-dev/kernel-dev-common:modifying an existing recipe`" +See the ":ref:`kernel-dev/common:modifying an existing recipe`" section for more information. Here is an example that shows a trivial tree of kernel Metadata stored diff --git a/poky/documentation/kernel-dev/kernel-dev-common.rst b/poky/documentation/kernel-dev/common.rst index 72d9d7879..6691da448 100644 --- a/poky/documentation/kernel-dev/kernel-dev-common.rst +++ b/poky/documentation/kernel-dev/common.rst @@ -21,11 +21,11 @@ Preparing the Build Host to Work on the Kernel Before you can do any kernel development, you need to be sure your build host is set up to use the Yocto Project. For information on how to get -set up, see the ":doc:`../dev-manual/dev-manual-start`" section in +set up, see the ":doc:`/dev-manual/start`" section in the Yocto Project Development Tasks Manual. Part of preparing the system is creating a local Git repository of the :term:`Source Directory` (``poky``) on your system. Follow the steps in the -":ref:`dev-manual/dev-manual-start:cloning the \`\`poky\`\` repository`" +":ref:`dev-manual/start:cloning the \`\`poky\`\` repository`" section in the Yocto Project Development Tasks Manual to set up your Source Directory. @@ -34,12 +34,12 @@ Source Directory. Be sure you check out the appropriate development branch or you create your local branch by checking out a specific tag to get the desired version of Yocto Project. See the - ":ref:`dev-manual/dev-manual-start:checking out by branch in poky`" and - ":ref:`dev-manual/dev-manual-start:checking out by tag in poky`" + ":ref:`dev-manual/start:checking out by branch in poky`" and + ":ref:`dev-manual/start:checking out by tag in poky`" sections in the Yocto Project Development Tasks Manual for more information. Kernel development is best accomplished using -:ref:`devtool <sdk-manual/sdk-extensible:using \`\`devtool\`\` in your sdk workflow>` +:ref:`devtool <sdk-manual/extensible:using \`\`devtool\`\` in your sdk workflow>` and not through traditional kernel workflow methods. The remainder of this section provides information for both scenarios. @@ -49,7 +49,7 @@ Getting Ready to Develop Using ``devtool`` Follow these steps to prepare to update the kernel image using ``devtool``. Completing this procedure leaves you with a clean kernel image and ready to make modifications as described in the -":ref:`kernel-dev/kernel-dev-common:using \`\`devtool\`\` to patch the kernel`" +":ref:`kernel-dev/common:using \`\`devtool\`\` to patch the kernel`" section: 1. *Initialize the BitBake Environment:* Before building an extensible @@ -63,7 +63,7 @@ section: .. note:: The previous commands assume the - :ref:`overview-manual/overview-manual-development-environment:yocto project source repositories` + :ref:`overview-manual/development-environment:yocto project source repositories` (i.e. ``poky``) have been cloned using Git and the local repository is named "poky". @@ -104,13 +104,13 @@ section: For background information on working with common and BSP layers, see the - ":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" + ":ref:`dev-manual/common-tasks:understanding and creating layers`" section in the Yocto Project Development Tasks Manual and the ":ref:`bsp-guide/bsp:bsp layers`" section in the Yocto Project Board Support (BSP) Developer's Guide, respectively. For information on how to use the ``bitbake-layers create-layer`` command to quickly set up a layer, see the - ":ref:`dev-manual/dev-manual-common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" + ":ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" section in the Yocto Project Development Tasks Manual. 4. *Inform the BitBake Build Environment About Your Layer:* As directed @@ -147,8 +147,8 @@ section: :: $ cd ~/poky/build/tmp/deploy/sdk - $ ./poky-glibc-x86_64-core-image-minimal-i586-toolchain-ext-3.1.2.sh - Poky (Yocto Project Reference Distro) Extensible SDK installer version 3.1.2 + $ ./poky-glibc-x86_64-core-image-minimal-i586-toolchain-ext-&DISTRO;.sh + Poky (Yocto Project Reference Distro) Extensible SDK installer version &DISTRO; ============================================================================ Enter target directory for SDK (default: ~/poky_sdk): You are about to install the SDK to "/home/scottrif/poky_sdk". Proceed [Y/n]? Y @@ -207,12 +207,12 @@ section: building for actual hardware and not for emulation, you could flash the image to a USB stick on ``/dev/sdd`` and boot your device. For an example that uses a Minnowboard, see the - :yocto_wiki:`TipsAndTricks/KernelDevelopmentWithEsdk </wiki/TipsAndTricks/KernelDevelopmentWithEsdk>` + :yocto_wiki:`TipsAndTricks/KernelDevelopmentWithEsdk </TipsAndTricks/KernelDevelopmentWithEsdk>` Wiki page. At this point you have set up to start making modifications to the kernel by using the extensible SDK. For a continued example, see the -":ref:`kernel-dev/kernel-dev-common:using \`\`devtool\`\` to patch the kernel`" +":ref:`kernel-dev/common:using \`\`devtool\`\` to patch the kernel`" section. Getting Ready for Traditional Kernel Development @@ -226,7 +226,7 @@ you will be editing these files. Follow these steps to prepare to update the kernel image using traditional kernel development flow with the Yocto Project. Completing this procedure leaves you ready to make modifications to the kernel -source as described in the ":ref:`kernel-dev/kernel-dev-common:using traditional kernel development to patch the kernel`" +source as described in the ":ref:`kernel-dev/common:using traditional kernel development to patch the kernel`" section: 1. *Initialize the BitBake Environment:* Before you can do anything @@ -236,7 +236,7 @@ section: Also, for this example, be sure that the local branch you have checked out for ``poky`` is the Yocto Project &DISTRO_NAME; branch. If you need to checkout out the &DISTRO_NAME; branch, see the - ":ref:`dev-manual/dev-manual-start:checking out by branch in poky`" + ":ref:`dev-manual/start:checking out by branch in poky`" section in the Yocto Project Development Tasks Manual. :: @@ -249,7 +249,7 @@ section: .. note:: The previous commands assume the - :ref:`overview-manual/overview-manual-development-environment:yocto project source repositories` + :ref:`overview-manual/development-environment:yocto project source repositories` (i.e. ``poky``) have been cloned using Git and the local repository is named "poky". @@ -289,13 +289,13 @@ section: For background information on working with common and BSP layers, see the - ":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" + ":ref:`dev-manual/common-tasks:understanding and creating layers`" section in the Yocto Project Development Tasks Manual and the ":ref:`bsp-guide/bsp:bsp layers`" section in the Yocto Project Board Support (BSP) Developer's Guide, respectively. For information on how to use the ``bitbake-layers create-layer`` command to quickly set up a layer, see the - ":ref:`dev-manual/dev-manual-common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" + ":ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" section in the Yocto Project Development Tasks Manual. 4. *Inform the BitBake Build Environment About Your Layer:* As directed @@ -378,7 +378,7 @@ layer contains its own :term:`BitBake` append files (``.bbappend``) and provides a convenient mechanism to create your own recipe files (``.bb``) as well as store and use kernel patch files. For background information on working with layers, see the -":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" +":ref:`dev-manual/common-tasks:understanding and creating layers`" section in the Yocto Project Development Tasks Manual. .. note:: @@ -386,7 +386,7 @@ section in the Yocto Project Development Tasks Manual. The Yocto Project comes with many tools that simplify tasks you need to perform. One such tool is the ``bitbake-layers create-layer`` command, which simplifies creating a new layer. See the - ":ref:`dev-manual/dev-manual-common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" + ":ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" section in the Yocto Project Development Tasks Manual for information on how to use this script to quick set up a new layer. @@ -443,7 +443,7 @@ home directory: The :term:`FILESEXTRAPATHS` and :term:`SRC_URI` statements enable the OpenEmbedded build system to find patch files. For more information on using append files, see the - ":ref:`dev-manual/dev-manual-common-tasks:using .bbappend files in your layer`" + ":ref:`dev-manual/common-tasks:using .bbappend files in your layer`" section in the Yocto Project Development Tasks Manual. Modifying an Existing Recipe @@ -457,11 +457,11 @@ the :term:`Source Directory` in Modifying an existing recipe can consist of the following: -- :ref:`kernel-dev/kernel-dev-common:creating the append file` +- :ref:`kernel-dev/common:creating the append file` -- :ref:`kernel-dev/kernel-dev-common:applying patches` +- :ref:`kernel-dev/common:applying patches` -- :ref:`kernel-dev/kernel-dev-common:changing the configuration` +- :ref:`kernel-dev/common:changing the configuration` Before modifying an existing recipe, be sure that you have created a minimal, custom layer from which you can work. See the "`Creating and @@ -502,7 +502,7 @@ your layer in the following area: .. note:: If you are working on a new machine Board Support Package (BSP), be - sure to refer to the :doc:`../bsp-guide/bsp-guide`. + sure to refer to the :doc:`/bsp-guide/index`. As an example, consider the following append file used by the BSPs in ``meta-yocto-bsp``: @@ -642,9 +642,9 @@ and applies the patches before building the kernel. For a detailed example showing how to patch the kernel using ``devtool``, see the -":ref:`kernel-dev/kernel-dev-common:using \`\`devtool\`\` to patch the kernel`" +":ref:`kernel-dev/common:using \`\`devtool\`\` to patch the kernel`" and -":ref:`kernel-dev/kernel-dev-common:using traditional kernel development to patch the kernel`" +":ref:`kernel-dev/common:using traditional kernel development to patch the kernel`" sections. Changing the Configuration @@ -769,7 +769,7 @@ the extensible SDK and ``devtool``. Before attempting this procedure, be sure you have performed the steps to get ready for updating the kernel as described in the - ":ref:`kernel-dev/kernel-dev-common:getting ready to develop using \`\`devtool\`\``" + ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" section. Patching the kernel involves changing or adding configurations to an @@ -782,7 +782,7 @@ output at boot time through ``printk`` statements in the kernel's ``calibrate.c`` source code file. Applying the patch and booting the modified image causes the added messages to appear on the emulator's console. The example is a continuation of the setup procedure found in -the ":ref:`kernel-dev/kernel-dev-common:getting ready to develop using \`\`devtool\`\``" Section. +the ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" Section. 1. *Check Out the Kernel Source Files:* First you must use ``devtool`` 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 .. note:: See this step in the - ":ref:`kernel-dev/kernel-dev-common:getting ready to develop using \`\`devtool\`\``" + ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" section for more information. Use the following ``devtool`` command to check out the code: @@ -862,7 +862,7 @@ the ":ref:`kernel-dev/kernel-dev-common:getting ready to develop using \`\`devto If the image you originally created resulted in a Wic file, you can use an alternate method to create the new image with the updated kernel. For an example, see the steps in the - :yocto_wiki:`TipsAndTricks/KernelDevelopmentWithEsdk </wiki/TipsAndTricks/KernelDevelopmentWithEsdk>` + :yocto_wiki:`TipsAndTricks/KernelDevelopmentWithEsdk </TipsAndTricks/KernelDevelopmentWithEsdk>` Wiki Page. :: @@ -912,7 +912,7 @@ the ":ref:`kernel-dev/kernel-dev-common:getting ready to develop using \`\`devto .. note:: See Step 3 of the - ":ref:`kernel-dev/kernel-dev-common:getting ready to develop using \`\`devtool\`\``" + ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" section for information on setting up this layer. Once the command @@ -935,14 +935,14 @@ Using Traditional Kernel Development to Patch the Kernel The steps in this procedure show you how you can patch the kernel using traditional kernel development (i.e. not using ``devtool`` and the extensible SDK as described in the -":ref:`kernel-dev/kernel-dev-common:using \`\`devtool\`\` to patch the kernel`" +":ref:`kernel-dev/common:using \`\`devtool\`\` to patch the kernel`" section). .. note:: Before attempting this procedure, be sure you have performed the steps to get ready for updating the kernel as described in the - ":ref:`kernel-dev/kernel-dev-common:getting ready for traditional kernel development`" + ":ref:`kernel-dev/common:getting ready for traditional kernel development`" section. Patching the kernel involves changing or adding configurations to an @@ -1108,7 +1108,7 @@ Section. For more information on append files and patches, see the "`Creating the Append File <#creating-the-append-file>`__" and "`Applying Patches <#applying-patches>`__" sections. You can also see the - ":ref:`dev-manual/dev-manual-common-tasks:using .bbappend files in your layer`" + ":ref:`dev-manual/common-tasks:using .bbappend files in your layer`" section in the Yocto Project Development Tasks Manual. .. note:: @@ -1190,9 +1190,9 @@ the tool and save your changes to create an updated version of the You can use the entire ``.config`` file as the ``defconfig`` file. For information on ``defconfig`` files, see the - ":ref:`kernel-dev/kernel-dev-common:changing the configuration`", - ":ref:`kernel-dev/kernel-dev-common:using an "in-tree" \`\`defconfig\`\` file`", - and ":ref:`kernel-dev/kernel-dev-common:creating a \`\`defconfig\`\` file`" + ":ref:`kernel-dev/common:changing the configuration`", + ":ref:`kernel-dev/common:using an "in-tree" \`\`defconfig\`\` file`", + and ":ref:`kernel-dev/common:creating a \`\`defconfig\`\` file`" sections. Consider 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`. For more information about where the ``.config`` file is located, see the example in the - ":ref:`kernel-dev/kernel-dev-common:using \`\`menuconfig\`\``" + ":ref:`kernel-dev/common:using \`\`menuconfig\`\``" section. It 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. .. note:: You can also use this method to create configuration fragments for a - BSP. See the ":ref:`kernel-dev/kernel-dev-advanced:bsp descriptions`" + BSP. See the ":ref:`kernel-dev/advanced:bsp descriptions`" section for more information. Where 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 fragment. In order to run this task, you must have an existing ``.config`` file. -See the ":ref:`kernel-dev/kernel-dev-common:using \`\`menuconfig\`\``" section for +See the ":ref:`kernel-dev/common:using \`\`menuconfig\`\``" section for information on how to create a configuration file. Following is sample output from the ``do_kernel_configcheck`` task: @@ -1496,7 +1496,7 @@ and tasks until they produce no warnings. For more information on how to use the ``menuconfig`` tool, see the -:ref:`kernel-dev/kernel-dev-common:using \`\`menuconfig\`\`` section. +:ref:`kernel-dev/common:using \`\`menuconfig\`\`` section. Fine-Tuning the Kernel Configuration File ----------------------------------------- @@ -1612,7 +1612,7 @@ source directory. Follow these steps to clean up the version string: Depending on your particular kernel development workflow, the commands you use to rebuild the kernel might differ. For information on building the kernel image when using ``devtool``, see the - ":ref:`kernel-dev/kernel-dev-common:using \`\`devtool\`\` to patch the kernel`" + ":ref:`kernel-dev/common:using \`\`devtool\`\` to patch the kernel`" section. For information on building the kernel image when using Bitbake, see the "`Using Traditional Kernel Development to Patch the @@ -1942,7 +1942,7 @@ Adding Recipe-Space Kernel Features =================================== You can add kernel features in the -:ref:`recipe-space <kernel-dev/kernel-dev-advanced:recipe-space metadata>` +:ref:`recipe-space <kernel-dev/advanced:recipe-space metadata>` by using the :term:`KERNEL_FEATURES` variable and by specifying the feature's ``.scc`` file path in the :term:`SRC_URI` statement. When you @@ -1961,7 +1961,7 @@ OpenEmbedded build system searches all forms of kernel Metadata on the ``SRC_URI`` statement regardless of whether the Metadata is in the "kernel-cache", system kernel Metadata, or a recipe-space Metadata (i.e. part of the kernel recipe). See the -":ref:`kernel-dev/kernel-dev-advanced:kernel metadata location`" section for +":ref:`kernel-dev/advanced:kernel metadata location`" section for additional information. When you specify the feature's ``.scc`` file on the ``SRC_URI`` diff --git a/poky/documentation/kernel-dev/kernel-dev-concepts-appx.rst b/poky/documentation/kernel-dev/concepts-appx.rst index 470d6ce1c..4b6dbe5ef 100644 --- a/poky/documentation/kernel-dev/kernel-dev-concepts-appx.rst +++ b/poky/documentation/kernel-dev/concepts-appx.rst @@ -35,7 +35,7 @@ Yocto Project Linux kernel that caters to specific embedded designer needs for targeted hardware. You can find a web interface to the Yocto Linux kernels in the -:ref:`overview-manual/overview-manual-development-environment:yocto project source repositories` +:ref:`overview-manual/development-environment:yocto project source repositories` at :yocto_git:`/`. If you look at the interface, you will see to the left a grouping of Git repositories titled "Yocto Linux Kernel". Within this group, you will find several Linux Yocto kernels developed @@ -71,7 +71,7 @@ and included with Yocto Project releases: and configurations for the linux-yocto kernel tree. This repository is useful when working on the linux-yocto kernel. For more information on this "Advanced Kernel Metadata", see the - ":doc:`kernel-dev-advanced`" Chapter. + ":doc:`/kernel-dev/advanced`" Chapter. - *linux-yocto-dev:* A development kernel based on the latest upstream release candidate available. @@ -160,7 +160,7 @@ implemented by the Yocto Project team using the Source Code Manager - You can find documentation on Git at https://git-scm.com/doc. You can also get an introduction to Git as it applies to the Yocto Project in the - ":ref:`overview-manual/overview-manual-development-environment:git`" section in the Yocto Project + ":ref:`overview-manual/development-environment:git`" section in the Yocto Project Overview and Concepts Manual. The latter reference provides an overview of Git and presents a minimal set of Git commands that allows you to be functional using Git. You can use as much, or as @@ -258,7 +258,7 @@ Yocto Linux kernel needed for any given set of requirements. Yocto Linux kernels, but rather shows a single generic kernel just for conceptual purposes. Also keep in mind that this structure represents the - :ref:`overview-manual/overview-manual-development-environment:yocto project source repositories` + :ref:`overview-manual/development-environment:yocto project source repositories` that are either pulled from during the build or established on the host development system prior to the build by either cloning a particular kernel's Git repository or by downloading and unpacking a @@ -293,13 +293,13 @@ ways: - *Files Accessed While using devtool:* ``devtool``, which is available with the Yocto Project, is the preferred method by which to - modify the kernel. See the ":ref:`kernel-dev/kernel-dev-intro:kernel modification workflow`" section. + modify the kernel. See the ":ref:`kernel-dev/intro:kernel modification workflow`" section. - *Cloned Repository:* If you are working in the kernel all the time, you probably would want to set up your own local Git repository of the Yocto Linux kernel tree. For information on how to clone a Yocto Linux kernel Git repository, see the - ":ref:`kernel-dev/kernel-dev-common:preparing the build host to work on the kernel`" + ":ref:`kernel-dev/common:preparing the build host to work on the kernel`" section. - *Temporary Source Files from a Build:* If you just need to make some @@ -327,11 +327,11 @@ source files used during the build. Again, for additional information on the Yocto Project kernel's architecture and its branching strategy, see the -":ref:`kernel-dev/kernel-dev-concepts-appx:yocto linux kernel architecture and branching strategies`" +":ref:`kernel-dev/concepts-appx:yocto linux kernel architecture and branching strategies`" section. You can also reference the -":ref:`kernel-dev/kernel-dev-common:using \`\`devtool\`\` to patch the kernel`" +":ref:`kernel-dev/common:using \`\`devtool\`\` to patch the kernel`" and -":ref:`kernel-dev/kernel-dev-common:using traditional kernel development to patch the kernel`" +":ref:`kernel-dev/common:using traditional kernel development to patch the kernel`" sections for detailed example that modifies the kernel. Determining 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 most developers can ignore. For general information on kernel configuration including ``menuconfig``, ``defconfig`` files, and configuration fragments, see the -":ref:`kernel-dev/kernel-dev-common:configuring the kernel`" section. +":ref:`kernel-dev/common:configuring the kernel`" section. During this part of the audit phase, the contents of the final ``.config`` file are compared against the fragments specified by the diff --git a/poky/documentation/kernel-dev/kernel-dev-faq.rst b/poky/documentation/kernel-dev/faq.rst index 424e62617..c2106f81e 100644 --- a/poky/documentation/kernel-dev/kernel-dev-faq.rst +++ b/poky/documentation/kernel-dev/faq.rst @@ -13,21 +13,21 @@ How do I use my own Linux kernel ``.config`` file? -------------------------------------------------- Refer to the -":ref:`kernel-dev/kernel-dev-common:changing the configuration`" +":ref:`kernel-dev/common:changing the configuration`" section for information. How do I create configuration fragments? ---------------------------------------- A: Refer to the -":ref:`kernel-dev/kernel-dev-common:creating configuration fragments`" +":ref:`kernel-dev/common:creating configuration fragments`" section for information. How do I use my own Linux kernel sources? ----------------------------------------- Refer to the -":ref:`kernel-dev/kernel-dev-common:working with your own sources`" +":ref:`kernel-dev/common:working with your own sources`" section for information. How do I install/not-install the kernel image on the rootfs? @@ -38,7 +38,7 @@ The kernel image (e.g. ``vmlinuz``) is provided by the specify whether or not the kernel image is installed in the generated root filesystem, override ``RDEPENDS_${KERNEL_PACKAGE_NAME}-base`` to include or not include "kernel-image". See the -":ref:`dev-manual/dev-manual-common-tasks:using .bbappend files in your layer`" +":ref:`dev-manual/common-tasks:using .bbappend files in your layer`" section in the Yocto Project Development Tasks Manual for information on how to use an append file to override metadata. @@ -63,7 +63,7 @@ machine: MACHINE_EXTRA_RRECOMMENDS += "kernel-module-ab123" For more information, see the -":ref:`kernel-dev/kernel-dev-common:incorporating out-of-tree modules`" section. +":ref:`kernel-dev/common:incorporating out-of-tree modules`" section. How do I change the Linux kernel command line? ---------------------------------------------- diff --git a/poky/documentation/kernel-dev/kernel-dev.rst b/poky/documentation/kernel-dev/index.rst index 55b42ed99..a8848ec8c 100644 --- a/poky/documentation/kernel-dev/kernel-dev.rst +++ b/poky/documentation/kernel-dev/index.rst @@ -10,12 +10,12 @@ Yocto Project Linux Kernel Development Manual :caption: Table of Contents :numbered: - kernel-dev-intro - kernel-dev-common - kernel-dev-advanced - kernel-dev-concepts-appx - kernel-dev-maint-appx - kernel-dev-faq + intro + common + advanced + concepts-appx + maint-appx + faq history .. include:: /boilerplate.rst diff --git a/poky/documentation/kernel-dev/kernel-dev-intro.rst b/poky/documentation/kernel-dev/intro.rst index 309c65b4d..c95d2f7cb 100644 --- a/poky/documentation/kernel-dev/kernel-dev-intro.rst +++ b/poky/documentation/kernel-dev/intro.rst @@ -27,7 +27,7 @@ and supported for at least one additional Yocto Project release. As they align, these previous releases are updated to include the latest from the Long Term Support Initiative (LTSI) project. You can learn more about Yocto Linux kernels and LTSI in the -":ref:`kernel-dev/kernel-dev-concepts-appx:yocto project kernel development and maintenance`" section. +":ref:`kernel-dev/concepts-appx:yocto project kernel development and maintenance`" section. Also included is a Yocto Linux kernel development recipe (``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. .. note:: For more on Yocto Linux kernels, see the - ":ref:`kernel-dev/kernel-dev-concepts-appx:yocto project kernel development and maintenance`" + ":ref:`kernel-dev/concepts-appx:yocto project kernel development and maintenance`" section. The Yocto Project also provides a powerful set of kernel tools for @@ -79,16 +79,16 @@ facilitate the process of working with the kernel recipes. If you find you need some additional background, please be sure to review and understand the following documentation: -- :doc:`../brief-yoctoprojectqs/brief-yoctoprojectqs` document. +- :doc:`/brief-yoctoprojectqs/index` document. -- :doc:`../overview-manual/overview-manual`. +- :doc:`/overview-manual/index`. - :ref:`devtool - workflow <sdk-manual/sdk-extensible:using \`\`devtool\`\` in your sdk workflow>` + workflow <sdk-manual/extensible:using \`\`devtool\`\` in your sdk workflow>` as described in the Yocto Project Application Development and the Extensible Software Development Kit (eSDK) manual. -- The ":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" +- The ":ref:`dev-manual/common-tasks:understanding and creating layers`" section in the Yocto Project Development Tasks Manual. - The "`Kernel Modification @@ -111,7 +111,7 @@ general information and references for further information. :align: center 1. *Set up Your Host Development System to Support Development Using the - Yocto Project*: See the ":doc:`../dev-manual/dev-manual-start`" section in + Yocto Project*: See the ":doc:`/dev-manual/start`" section in the Yocto Project Development Tasks Manual for options on how to get a build host ready to use the Yocto Project. @@ -124,13 +124,13 @@ general information and references for further information. Using ``devtool`` and the eSDK requires that you have a clean build of the image and that you are set up with the appropriate eSDK. For more information, see the - ":ref:`kernel-dev/kernel-dev-common:getting ready to develop using \`\`devtool\`\``" + ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" section. Using traditional kernel development requires that you have the kernel source available in an isolated local Git repository. For more information, see the - ":ref:`kernel-dev/kernel-dev-common:getting ready for traditional kernel development`" + ":ref:`kernel-dev/common:getting ready for traditional kernel development`" section. 3. *Make Changes to the Kernel Source Code if applicable:* Modifying the @@ -138,17 +138,17 @@ general information and references for further information. if you have to do this, you make the changes to the files in the eSDK's Build Directory if you are using ``devtool``. For more information, see the - ":ref:`kernel-dev/kernel-dev-common:using \`\`devtool\`\` to patch the kernel`" + ":ref:`kernel-dev/common:using \`\`devtool\`\` to patch the kernel`" section. If you are using traditional kernel development, you edit the source files in the kernel's local Git repository. For more information, see the - ":ref:`kernel-dev/kernel-dev-common:using traditional kernel development to patch the kernel`" + ":ref:`kernel-dev/common:using traditional kernel development to patch the kernel`" section. 4. *Make Kernel Configuration Changes if Applicable:* If your situation calls for changing the kernel's configuration, you can use - :ref:`menuconfig <kernel-dev/kernel-dev-common:using \`\`menuconfig\`\`>`, + :ref:`menuconfig <kernel-dev/common:using \`\`menuconfig\`\`>`, which allows you to interactively develop and test the configuration changes you are making to the kernel. Saving changes you make with ``menuconfig`` @@ -165,7 +165,7 @@ general information and references for further information. ``menuconfig`` and you have saved them, you can directly compare the resulting ``.config`` file against an existing original and gather those changes into a - :ref:`configuration fragment file <kernel-dev/kernel-dev-common:creating configuration fragments>` to be + :ref:`configuration fragment file <kernel-dev/common:creating configuration fragments>` to be referenced from within the kernel's ``.bbappend`` file. Additionally, if you are working in a BSP layer and need to modify diff --git a/poky/documentation/kernel-dev/kernel-dev-maint-appx.rst b/poky/documentation/kernel-dev/maint-appx.rst index 69f680688..89f4b4334 100644 --- a/poky/documentation/kernel-dev/kernel-dev-maint-appx.rst +++ b/poky/documentation/kernel-dev/maint-appx.rst @@ -37,7 +37,7 @@ kernel that branches off ``linux.org`` version 4.12 and the For more information on how to set up a local Git repository of the Yocto Project Linux kernel files, see the -":ref:`kernel-dev/kernel-dev-common:preparing the build host to work on the kernel`" +":ref:`kernel-dev/common:preparing the build host to work on the kernel`" section. Once you have cloned the kernel Git repository and the cache of Metadata @@ -103,7 +103,7 @@ patch, or BSP: located by searching these system directories: - The in-tree kernel-cache directories, which are located in the - :yocto_git:`yocto-kernel-cache </cgit/cgit.cgi/yocto-kernel-cache/tree/bsp>` + :yocto_git:`yocto-kernel-cache </yocto-kernel-cache/tree/bsp>` repository organized under the "Yocto Linux Kernel" heading in the :yocto_git:`Yocto Project Source Repositories <>`. @@ -167,7 +167,7 @@ specific to some target hardware. The end result is a branched, clean history tree that makes up the kernel for a given release. You can see the script (``kgit-scc``) responsible for this in the - :yocto_git:`yocto-kernel-tools </cgit.cgi/yocto-kernel-tools/tree/tools>` + :yocto_git:`yocto-kernel-tools </yocto-kernel-tools/tree/tools>` repository. - The steps used to construct the full kernel tree are the same |