diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-12-03 22:38:39 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-12-09 12:21:27 +0000 |
commit | a0afa48859def9f6410ad1d3b1296683e14fc2b7 (patch) | |
tree | 17ffdd77f568ab53fb28f031e37dfce82e22243b /documentation/ref-manual | |
parent | af6f5d821d39b50c3c4b45a593324346fce0d723 (diff) | |
download | poky-a0afa48859def9f6410ad1d3b1296683e14fc2b7.tar.gz |
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 <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r-- | documentation/ref-manual/ref-classes.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/ref-tasks.rst | 8 | ||||
-rw-r--r-- | documentation/ref-manual/ref-variables.rst | 14 |
3 files changed, 12 insertions, 12 deletions
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 | |||
1596 | everything needed to build and package a kernel module. | 1596 | everything needed to build and package a kernel module. |
1597 | 1597 | ||
1598 | For general information on out-of-tree Linux kernel modules, see the | 1598 | For general information on out-of-tree Linux kernel modules, see the |
1599 | ":ref:`kernel-dev/kernel-dev-common:incorporating out-of-tree modules`" | 1599 | ":ref:`kernel-dev/common:incorporating out-of-tree modules`" |
1600 | section in the Yocto Project Linux Kernel Development Manual. | 1600 | section in the Yocto Project Linux Kernel Development Manual. |
1601 | 1601 | ||
1602 | .. _ref-classes-module-base: | 1602 | .. _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: | |||
693 | $ bitbake linux-yocto -c diffconfig | 693 | $ bitbake linux-yocto -c diffconfig |
694 | 694 | ||
695 | For more information, see the | 695 | For more information, see the |
696 | ":ref:`kernel-dev/kernel-dev-common:creating configuration fragments`" | 696 | ":ref:`kernel-dev/common:creating configuration fragments`" |
697 | section in the Yocto Project Linux Kernel Development Manual. | 697 | section in the Yocto Project Linux Kernel Development Manual. |
698 | 698 | ||
699 | .. _ref-tasks-kernel_checkout: | 699 | .. _ref-tasks-kernel_checkout: |
@@ -724,7 +724,7 @@ following command: | |||
724 | $ bitbake linux-yocto -c kernel_configcheck -f | 724 | $ bitbake linux-yocto -c kernel_configcheck -f |
725 | 725 | ||
726 | For more information, see the | 726 | For more information, see the |
727 | ":ref:`kernel-dev/kernel-dev-common:validating configuration`" | 727 | ":ref:`kernel-dev/common:validating configuration`" |
728 | section in the Yocto Project Linux Kernel Development Manual. | 728 | section in the Yocto Project Linux Kernel Development Manual. |
729 | 729 | ||
730 | .. _ref-tasks-kernel_configme: | 730 | .. _ref-tasks-kernel_configme: |
@@ -756,7 +756,7 @@ tool, which you then use to modify the kernel configuration. | |||
756 | $ bitbake linux-yocto -c menuconfig | 756 | $ bitbake linux-yocto -c menuconfig |
757 | 757 | ||
758 | 758 | ||
759 | See the ":ref:`kernel-dev/kernel-dev-common:using \`\`menuconfig\`\``" | 759 | See the ":ref:`kernel-dev/common:using \`\`menuconfig\`\``" |
760 | section in the Yocto Project Linux Kernel Development Manual for more | 760 | section in the Yocto Project Linux Kernel Development Manual for more |
761 | information on this configuration tool. | 761 | information on this configuration tool. |
762 | 762 | ||
@@ -780,7 +780,7 @@ which can then be applied by subsequent tasks such as | |||
780 | 780 | ||
781 | Runs ``make menuconfig`` for the kernel. For information on | 781 | Runs ``make menuconfig`` for the kernel. For information on |
782 | ``menuconfig``, see the | 782 | ``menuconfig``, see the |
783 | ":ref:`kernel-dev/kernel-dev-common:using \`\`menuconfig\`\``" | 783 | ":ref:`kernel-dev/common:using \`\`menuconfig\`\``" |
784 | section in the Yocto Project Linux Kernel Development Manual. | 784 | section in the Yocto Project Linux Kernel Development Manual. |
785 | 785 | ||
786 | .. _ref-tasks-savedefconfig: | 786 | .. _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. | |||
3723 | - qemu | 3723 | - qemu |
3724 | - mips | 3724 | - mips |
3725 | 3725 | ||
3726 | You define the ``KARCH`` variable in the :ref:`kernel-dev/kernel-dev-advanced:bsp descriptions`. | 3726 | You define the ``KARCH`` variable in the :ref:`kernel-dev/advanced:bsp descriptions`. |
3727 | 3727 | ||
3728 | :term:`KBRANCH` | 3728 | :term:`KBRANCH` |
3729 | A regular expression used by the build process to explicitly identify | 3729 | 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. | |||
3793 | 3793 | ||
3794 | For more | 3794 | For more |
3795 | information on how to use the ``KBUILD_DEFCONFIG`` variable, see the | 3795 | information on how to use the ``KBUILD_DEFCONFIG`` variable, see the |
3796 | ":ref:`kernel-dev/kernel-dev-common:using an "in-tree" \`\`defconfig\`\` file`" | 3796 | ":ref:`kernel-dev/common:using an "in-tree" \`\`defconfig\`\` file`" |
3797 | section in the Yocto Project Linux Kernel Development Manual. | 3797 | section in the Yocto Project Linux Kernel Development Manual. |
3798 | 3798 | ||
3799 | :term:`KERNEL_ALT_IMAGETYPE` | 3799 | :term:`KERNEL_ALT_IMAGETYPE` |
@@ -4029,7 +4029,7 @@ system and gives an overview of their function and contents. | |||
4029 | of the :term:`STAGING_KERNEL_DIR` within | 4029 | of the :term:`STAGING_KERNEL_DIR` within |
4030 | the :ref:`module <ref-classes-module>` class. For information on | 4030 | the :ref:`module <ref-classes-module>` class. For information on |
4031 | how this variable is used, see the | 4031 | how this variable is used, see the |
4032 | ":ref:`kernel-dev/kernel-dev-common:incorporating out-of-tree modules`" | 4032 | ":ref:`kernel-dev/common:incorporating out-of-tree modules`" |
4033 | section in the Yocto Project Linux Kernel Development Manual. | 4033 | section in the Yocto Project Linux Kernel Development Manual. |
4034 | 4034 | ||
4035 | To help maximize compatibility with out-of-tree drivers used to build | 4035 | 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. | |||
4043 | of the :term:`STAGING_KERNEL_DIR` within | 4043 | of the :term:`STAGING_KERNEL_DIR` within |
4044 | the :ref:`module <ref-classes-module>` class. For information on | 4044 | the :ref:`module <ref-classes-module>` class. For information on |
4045 | how this variable is used, see the | 4045 | how this variable is used, see the |
4046 | ":ref:`kernel-dev/kernel-dev-common:incorporating out-of-tree modules`" | 4046 | ":ref:`kernel-dev/common:incorporating out-of-tree modules`" |
4047 | section in the Yocto Project Linux Kernel Development Manual. | 4047 | section in the Yocto Project Linux Kernel Development Manual. |
4048 | 4048 | ||
4049 | To help maximize compatibility with out-of-tree drivers used to build | 4049 | 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. | |||
4108 | :term:`KTYPE` | 4108 | :term:`KTYPE` |
4109 | Defines the kernel type to be used in assembling the configuration. | 4109 | Defines the kernel type to be used in assembling the configuration. |
4110 | The linux-yocto recipes define "standard", "tiny", and "preempt-rt" | 4110 | The linux-yocto recipes define "standard", "tiny", and "preempt-rt" |
4111 | kernel types. See the ":ref:`kernel-dev/kernel-dev-advanced:kernel types`" | 4111 | kernel types. See the ":ref:`kernel-dev/advanced:kernel types`" |
4112 | section in the | 4112 | section in the |
4113 | Yocto Project Linux Kernel Development Manual for more information on | 4113 | Yocto Project Linux Kernel Development Manual for more information on |
4114 | kernel types. | 4114 | kernel types. |
4115 | 4115 | ||
4116 | You define the ``KTYPE`` variable in the | 4116 | You define the ``KTYPE`` variable in the |
4117 | :ref:`kernel-dev/kernel-dev-advanced:bsp descriptions`. The | 4117 | :ref:`kernel-dev/advanced:bsp descriptions`. The |
4118 | value you use must match the value used for the | 4118 | value you use must match the value used for the |
4119 | :term:`LINUX_KERNEL_TYPE` value used by the | 4119 | :term:`LINUX_KERNEL_TYPE` value used by the |
4120 | kernel recipe. | 4120 | kernel recipe. |
@@ -4343,7 +4343,7 @@ system and gives an overview of their function and contents. | |||
4343 | :term:`LINUX_KERNEL_TYPE` | 4343 | :term:`LINUX_KERNEL_TYPE` |
4344 | Defines the kernel type to be used in assembling the configuration. | 4344 | Defines the kernel type to be used in assembling the configuration. |
4345 | The linux-yocto recipes define "standard", "tiny", and "preempt-rt" | 4345 | The linux-yocto recipes define "standard", "tiny", and "preempt-rt" |
4346 | kernel types. See the ":ref:`kernel-dev/kernel-dev-advanced:kernel types`" | 4346 | kernel types. See the ":ref:`kernel-dev/advanced:kernel types`" |
4347 | section in the | 4347 | section in the |
4348 | Yocto Project Linux Kernel Development Manual for more information on | 4348 | Yocto Project Linux Kernel Development Manual for more information on |
4349 | kernel types. | 4349 | kernel types. |