summaryrefslogtreecommitdiffstats
path: root/documentation/kernel-dev/kernel-dev-intro.rst
diff options
context:
space:
mode:
authorRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-14 16:19:23 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-17 10:09:35 +0100
commitcb37a15cf5a150489ceaf55dc6cb014f0e787f6e (patch)
tree2df2f45981d11b46d34ca860a9582365f3efef10 /documentation/kernel-dev/kernel-dev-intro.rst
parentde89b5a0b6ecb9a5b6a3e5a862cf4cee32dc8a94 (diff)
downloadpoky-cb37a15cf5a150489ceaf55dc6cb014f0e787f6e.tar.gz
sphinx: kernel-dev: Various URL, code block and other fixes to imported data
(From yocto-docs rev: 4888b49ccc5d133b4096e5a9b808f14d1afc7deb) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/kernel-dev/kernel-dev-intro.rst')
-rw-r--r--documentation/kernel-dev/kernel-dev-intro.rst40
1 files changed, 20 insertions, 20 deletions
diff --git a/documentation/kernel-dev/kernel-dev-intro.rst b/documentation/kernel-dev/kernel-dev-intro.rst
index 6708a6afe9..21d43d5e80 100644
--- a/documentation/kernel-dev/kernel-dev-intro.rst
+++ b/documentation/kernel-dev/kernel-dev-intro.rst
@@ -28,8 +28,8 @@ newly-supported platforms. Previous recipes in the release are refreshed
28and supported for at least one additional Yocto Project release. As they 28and supported for at least one additional Yocto Project release. As they
29align, these previous releases are updated to include the latest from 29align, these previous releases are updated to include the latest from
30the Long Term Support Initiative (LTSI) project. You can learn more 30the Long Term Support Initiative (LTSI) project. You can learn more
31about Yocto Linux kernels and LTSI in the "`Yocto Project Kernel 31about Yocto Linux kernels and LTSI in the ":ref:`Yocto Project Kernel
32Development and Maintenance <#kernel-big-picture>`__" section. 32Development and Maintenance <kernel-big-picture>`" section.
33 33
34Also included is a Yocto Linux kernel development recipe 34Also included is a Yocto Linux kernel development recipe
35(``linux-yocto-dev.bb``) should you want to work with the very latest in 35(``linux-yocto-dev.bb``) should you want to work with the very latest in
@@ -81,17 +81,16 @@ facilitate the process of working with the kernel recipes. If you find
81you need some additional background, please be sure to review and 81you need some additional background, please be sure to review and
82understand the following documentation: 82understand the following documentation:
83 83
84- `Yocto Project Quick Build <&YOCTO_DOCS_BRIEF_URL;>`__ document. 84- :doc:`../brief-yoctoprojectqs/brief-yoctoprojectqs` document.
85 85
86- `Yocto Project Overview and Concepts Manual <&YOCTO_DOCS_OM_URL;>`__. 86- :doc:`../overview-manual/overview-manual`.
87 87
88- ```devtool`` 88- :ref:`devtool
89 workflow <&YOCTO_DOCS_SDK_URL;#using-devtool-in-your-sdk-workflow>`__ 89 workflow <sdk-manual/sdk-extensible:using \`\`devtool\`\` in your sdk workflow>`
90 as described in the Yocto Project Application Development and the 90 as described in the Yocto Project Application Development and the
91 Extensible Software Development Kit (eSDK) manual. 91 Extensible Software Development Kit (eSDK) manual.
92 92
93- The "`Understanding and Creating 93- The ":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`"
94 Layers <&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers>`__"
95 section in the Yocto Project Development Tasks Manual. 94 section in the Yocto Project Development Tasks Manual.
96 95
97- The "`Kernel Modification 96- The "`Kernel Modification
@@ -114,8 +113,7 @@ general information and references for further information.
114 :align: center 113 :align: center
115 114
1161. *Set up Your Host Development System to Support Development Using the 1151. *Set up Your Host Development System to Support Development Using the
117 Yocto Project*: See the "`Setting Up the Development Host to Use the 116 Yocto Project*: See the ":doc:`../dev-manual/dev-manual-start`" section in
118 Yocto Project <&YOCTO_DOCS_DEV_URL;#dev-manual-start>`__" section in
119 the Yocto Project Development Tasks Manual for options on how to get 117 the Yocto Project Development Tasks Manual for options on how to get
120 a build host ready to use the Yocto Project. 118 a build host ready to use the Yocto Project.
121 119
@@ -127,31 +125,33 @@ general information and references for further information.
127 125
128 Using ``devtool`` and the eSDK requires that you have a clean build 126 Using ``devtool`` and the eSDK requires that you have a clean build
129 of the image and that you are set up with the appropriate eSDK. For 127 of the image and that you are set up with the appropriate eSDK. For
130 more information, see the "`Getting Ready to Develop Using 128 more information, see the
131 ``devtool`` <#getting-ready-to-develop-using-devtool>`__" section. 129 ":ref:`kernel-dev/kernel-dev-common:getting ready to develop using \`\`devtool\`\``"
130 section.
132 131
133 Using traditional kernel development requires that you have the 132 Using traditional kernel development requires that you have the
134 kernel source available in an isolated local Git repository. For more 133 kernel source available in an isolated local Git repository. For more
135 information, see the "`Getting Ready for Traditional Kernel 134 information, see the
136 Development <#getting-ready-for-traditional-kernel-development>`__" 135 ":ref:`kernel-dev/kernel-dev-common:getting ready for traditional kernel development`"
137 section. 136 section.
138 137
1393. *Make Changes to the Kernel Source Code if applicable:* Modifying the 1383. *Make Changes to the Kernel Source Code if applicable:* Modifying the
140 kernel does not always mean directly changing source files. However, 139 kernel does not always mean directly changing source files. However,
141 if you have to do this, you make the changes to the files in the 140 if you have to do this, you make the changes to the files in the
142 eSDK's Build Directory if you are using ``devtool``. For more 141 eSDK's Build Directory if you are using ``devtool``. For more
143 information, see the "`Using ``devtool`` to Patch the 142 information, see the
144 Kernel <#using-devtool-to-patch-the-kernel>`__" section. 143 ":ref:`kernel-dev/kernel-dev-common:using \`\`devtool\`\` to patch the kernel`"
144 section.
145 145
146 If you are using traditional kernel development, you edit the source 146 If you are using traditional kernel development, you edit the source
147 files in the kernel's local Git repository. For more information, see 147 files in the kernel's local Git repository. For more information, see the
148 the "`Using Traditional Kernel Development to Patch the 148 ":ref:`kernel-dev/kernel-dev-common:using traditional kernel development to patch the kernel`"
149 Kernel <#using-traditional-kernel-development-to-patch-the-kernel>`__"
150 section. 149 section.
151 150
1524. *Make Kernel Configuration Changes if Applicable:* If your situation 1514. *Make Kernel Configuration Changes if Applicable:* If your situation
153 calls for changing the kernel's configuration, you can use 152 calls for changing the kernel's configuration, you can use
154 ```menuconfig`` <#using-menuconfig>`__, which allows you to 153 :ref:`menuconfig <kernel-dev/kernel-dev-common:using \`\`menuconfig\`\`>`,
154 which allows you to
155 interactively develop and test the configuration changes you are 155 interactively develop and test the configuration changes you are
156 making to the kernel. Saving changes you make with ``menuconfig`` 156 making to the kernel. Saving changes you make with ``menuconfig``
157 updates the kernel's ``.config`` file. 157 updates the kernel's ``.config`` file.