From af6f5d821d39b50c3c4b45a593324346fce0d723 Mon Sep 17 00:00:00 2001 From: Nicolas Dechesne Date: Thu, 3 Dec 2020 22:38:38 +0100 Subject: dev-manual: remove 'dev-manual' from filenames All filenames duplicate the 'manual name', which is not needed, and make all references longer than they should. Rename all files to be as consise as possible, and fix all references (From yocto-docs rev: 00a9244587e2e63f2a5197ed0dfc89cb330f9275) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie --- documentation/kernel-dev/kernel-dev-common.rst | 26 +++++++++++++------------- documentation/kernel-dev/kernel-dev-faq.rst | 2 +- documentation/kernel-dev/kernel-dev-intro.rst | 4 ++-- 3 files changed, 16 insertions(+), 16 deletions(-) (limited to 'documentation/kernel-dev') diff --git a/documentation/kernel-dev/kernel-dev-common.rst b/documentation/kernel-dev/kernel-dev-common.rst index 8e9bc27bf5..4bb553f8dd 100644 --- a/documentation/kernel-dev/kernel-dev-common.rst +++ b/documentation/kernel-dev/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,8 +34,8 @@ 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 @@ -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 @@ -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. :: @@ -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 @@ -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:: diff --git a/documentation/kernel-dev/kernel-dev-faq.rst b/documentation/kernel-dev/kernel-dev-faq.rst index 424e626170..54623453a4 100644 --- a/documentation/kernel-dev/kernel-dev-faq.rst +++ b/documentation/kernel-dev/kernel-dev-faq.rst @@ -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. diff --git a/documentation/kernel-dev/kernel-dev-intro.rst b/documentation/kernel-dev/kernel-dev-intro.rst index 29d4516c53..3987b0e59d 100644 --- a/documentation/kernel-dev/kernel-dev-intro.rst +++ b/documentation/kernel-dev/kernel-dev-intro.rst @@ -88,7 +88,7 @@ understand the following documentation: 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. -- cgit v1.2.3-54-g00ecf