From a0afa48859def9f6410ad1d3b1296683e14fc2b7 Mon Sep 17 00:00:00 2001 From: Nicolas Dechesne Date: Thu, 3 Dec 2020 22:38:39 +0100 Subject: kernel-dev: remove 'kernel-dev' 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: 3d7eb2c5e1d230290c97dd8e5b528086e1d8034a) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie --- documentation/ref-manual/ref-classes.rst | 2 +- documentation/ref-manual/ref-tasks.rst | 8 ++++---- documentation/ref-manual/ref-variables.rst | 14 +++++++------- 3 files changed, 12 insertions(+), 12 deletions(-) (limited to 'documentation/ref-manual') diff --git a/documentation/ref-manual/ref-classes.rst b/documentation/ref-manual/ref-classes.rst index 4147044ea3..914ca42324 100644 --- a/documentation/ref-manual/ref-classes.rst +++ b/documentation/ref-manual/ref-classes.rst @@ -1596,7 +1596,7 @@ and implements the :ref:`ref-tasks-compile` and everything needed to build and package a kernel module. For general information on out-of-tree Linux kernel modules, see the -":ref:`kernel-dev/kernel-dev-common:incorporating out-of-tree modules`" +":ref:`kernel-dev/common:incorporating out-of-tree modules`" section in the Yocto Project Linux Kernel Development Manual. .. _ref-classes-module-base: diff --git a/documentation/ref-manual/ref-tasks.rst b/documentation/ref-manual/ref-tasks.rst index 89731d459c..768c10eebd 100644 --- a/documentation/ref-manual/ref-tasks.rst +++ b/documentation/ref-manual/ref-tasks.rst @@ -693,7 +693,7 @@ from the command line as follows: $ bitbake linux-yocto -c diffconfig For more information, see the -":ref:`kernel-dev/kernel-dev-common:creating configuration fragments`" +":ref:`kernel-dev/common:creating configuration fragments`" section in the Yocto Project Linux Kernel Development Manual. .. _ref-tasks-kernel_checkout: @@ -724,7 +724,7 @@ following command: $ bitbake linux-yocto -c kernel_configcheck -f For more information, see the -":ref:`kernel-dev/kernel-dev-common:validating configuration`" +":ref:`kernel-dev/common:validating configuration`" section in the Yocto Project Linux Kernel Development Manual. .. _ref-tasks-kernel_configme: @@ -756,7 +756,7 @@ tool, which you then use to modify the kernel configuration. $ bitbake linux-yocto -c menuconfig -See the ":ref:`kernel-dev/kernel-dev-common:using \`\`menuconfig\`\``" +See the ":ref:`kernel-dev/common:using \`\`menuconfig\`\``" section in the Yocto Project Linux Kernel Development Manual for more information on this configuration tool. @@ -780,7 +780,7 @@ which can then be applied by subsequent tasks such as Runs ``make menuconfig`` for the kernel. For information on ``menuconfig``, see the -":ref:`kernel-dev/kernel-dev-common:using \`\`menuconfig\`\``" +":ref:`kernel-dev/common:using \`\`menuconfig\`\``" section in the Yocto Project Linux Kernel Development Manual. .. _ref-tasks-savedefconfig: diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst index 65f64b91a5..d98e358173 100644 --- a/documentation/ref-manual/ref-variables.rst +++ b/documentation/ref-manual/ref-variables.rst @@ -3723,7 +3723,7 @@ system and gives an overview of their function and contents. - qemu - mips - You define the ``KARCH`` variable in the :ref:`kernel-dev/kernel-dev-advanced:bsp descriptions`. + You define the ``KARCH`` variable in the :ref:`kernel-dev/advanced:bsp descriptions`. :term:`KBRANCH` A regular expression used by the build process to explicitly identify @@ -3793,7 +3793,7 @@ system and gives an overview of their function and contents. For more information on how to use the ``KBUILD_DEFCONFIG`` variable, see the - ":ref:`kernel-dev/kernel-dev-common:using an "in-tree" \`\`defconfig\`\` file`" + ":ref:`kernel-dev/common:using an "in-tree" \`\`defconfig\`\` file`" section in the Yocto Project Linux Kernel Development Manual. :term:`KERNEL_ALT_IMAGETYPE` @@ -4029,7 +4029,7 @@ system and gives an overview of their function and contents. of the :term:`STAGING_KERNEL_DIR` within the :ref:`module ` class. For information on how this variable is used, see the - ":ref:`kernel-dev/kernel-dev-common:incorporating out-of-tree modules`" + ":ref:`kernel-dev/common:incorporating out-of-tree modules`" section in the Yocto Project Linux Kernel Development Manual. To help maximize compatibility with out-of-tree drivers used to build @@ -4043,7 +4043,7 @@ system and gives an overview of their function and contents. of the :term:`STAGING_KERNEL_DIR` within the :ref:`module ` class. For information on how this variable is used, see the - ":ref:`kernel-dev/kernel-dev-common:incorporating out-of-tree modules`" + ":ref:`kernel-dev/common:incorporating out-of-tree modules`" section in the Yocto Project Linux Kernel Development Manual. To help maximize compatibility with out-of-tree drivers used to build @@ -4108,13 +4108,13 @@ system and gives an overview of their function and contents. :term:`KTYPE` Defines the kernel type to be used in assembling the configuration. The linux-yocto recipes define "standard", "tiny", and "preempt-rt" - kernel types. See the ":ref:`kernel-dev/kernel-dev-advanced:kernel types`" + kernel types. See the ":ref:`kernel-dev/advanced:kernel types`" section in the Yocto Project Linux Kernel Development Manual for more information on kernel types. You define the ``KTYPE`` variable in the - :ref:`kernel-dev/kernel-dev-advanced:bsp descriptions`. The + :ref:`kernel-dev/advanced:bsp descriptions`. The value you use must match the value used for the :term:`LINUX_KERNEL_TYPE` value used by the kernel recipe. @@ -4343,7 +4343,7 @@ system and gives an overview of their function and contents. :term:`LINUX_KERNEL_TYPE` Defines the kernel type to be used in assembling the configuration. The linux-yocto recipes define "standard", "tiny", and "preempt-rt" - kernel types. See the ":ref:`kernel-dev/kernel-dev-advanced:kernel types`" + kernel types. See the ":ref:`kernel-dev/advanced:kernel types`" section in the Yocto Project Linux Kernel Development Manual for more information on kernel types. -- cgit v1.2.3-54-g00ecf