diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-07-27 17:38:09 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-17 10:09:33 +0100 |
commit | 424567d629b08785a6594d16427ee0fa8c31f384 (patch) | |
tree | 4985979745b1c5601f7a82c662042fb745bfd7db /documentation/kernel-dev | |
parent | 4bf6fc5281d1976ad7113c91a93995406cfab429 (diff) | |
download | poky-424567d629b08785a6594d16427ee0fa8c31f384.tar.gz |
sphinx: manual updates for some links
Some links were not found by the regexp, especially because of they
are spanning across multiple lines. This patch is a manual fixup for
these patterns.
(From yocto-docs rev: 7a5cf8b372903d959d4a1f0882e6198f31f3cba5)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/kernel-dev')
-rw-r--r-- | documentation/kernel-dev/kernel-dev-common.rst | 31 | ||||
-rw-r--r-- | documentation/kernel-dev/kernel-dev-concepts-appx.rst | 4 | ||||
-rw-r--r-- | documentation/kernel-dev/kernel-dev-maint-appx.rst | 4 |
3 files changed, 19 insertions, 20 deletions
diff --git a/documentation/kernel-dev/kernel-dev-common.rst b/documentation/kernel-dev/kernel-dev-common.rst index f264cea159..813f4047e2 100644 --- a/documentation/kernel-dev/kernel-dev-common.rst +++ b/documentation/kernel-dev/kernel-dev-common.rst | |||
@@ -24,8 +24,8 @@ host is set up to use the Yocto Project. For information on how to get | |||
24 | set up, see the "`Preparing the Build | 24 | set up, see the "`Preparing the Build |
25 | Host <&YOCTO_DOCS_DEV_URL;#dev-preparing-the-build-host>`__" section in | 25 | Host <&YOCTO_DOCS_DEV_URL;#dev-preparing-the-build-host>`__" section in |
26 | the Yocto Project Development Tasks Manual. Part of preparing the system | 26 | the Yocto Project Development Tasks Manual. Part of preparing the system |
27 | is creating a local Git repository of the `Source | 27 | is creating a local Git repository of the |
28 | Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__ (``poky``) on your | 28 | :term:`Source Directory` (``poky``) on your |
29 | system. Follow the steps in the "`Cloning the ``poky`` | 29 | system. Follow the steps in the "`Cloning the ``poky`` |
30 | Repository <&YOCTO_DOCS_DEV_URL;#cloning-the-poky-repository>`__" | 30 | Repository <&YOCTO_DOCS_DEV_URL;#cloning-the-poky-repository>`__" |
31 | section in the Yocto Project Development Tasks Manual to set up your | 31 | section in the Yocto Project Development Tasks Manual to set up your |
@@ -76,8 +76,8 @@ section: | |||
76 | "qemux86-64", which is fine if you are building for the QEMU emulator | 76 | "qemux86-64", which is fine if you are building for the QEMU emulator |
77 | in 64-bit mode. However, if you are not, you need to set the | 77 | in 64-bit mode. However, if you are not, you need to set the |
78 | ``MACHINE`` variable appropriately in your ``conf/local.conf`` file | 78 | ``MACHINE`` variable appropriately in your ``conf/local.conf`` file |
79 | found in the `Build | 79 | found in the |
80 | Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__ (i.e. | 80 | :term:`Build Directory` (i.e. |
81 | ``~/poky/build`` in this example). | 81 | ``~/poky/build`` in this example). |
82 | 82 | ||
83 | Also, since you are preparing to work on the kernel image, you need | 83 | Also, since you are preparing to work on the kernel image, you need |
@@ -240,8 +240,8 @@ section: | |||
240 | "qemux86-64", which is fine if you are building for the QEMU emulator | 240 | "qemux86-64", which is fine if you are building for the QEMU emulator |
241 | in 64-bit mode. However, if you are not, you need to set the | 241 | in 64-bit mode. However, if you are not, you need to set the |
242 | ``MACHINE`` variable appropriately in your ``conf/local.conf`` file | 242 | ``MACHINE`` variable appropriately in your ``conf/local.conf`` file |
243 | found in the `Build | 243 | found in the |
244 | Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__ (i.e. | 244 | :term:`Build Directory` (i.e. |
245 | ``~/poky/build`` in this example). | 245 | ``~/poky/build`` in this example). |
246 | 246 | ||
247 | Also, since you are preparing to work on the kernel image, you need | 247 | Also, since you are preparing to work on the kernel image, you need |
@@ -289,8 +289,8 @@ section: | |||
289 | ` <&YOCTO_GIT_URL;>`__. | 289 | ` <&YOCTO_GIT_URL;>`__. |
290 | 290 | ||
291 | For simplicity, it is recommended that you create your copy of the | 291 | For simplicity, it is recommended that you create your copy of the |
292 | kernel Git repository outside of the `Source | 292 | kernel Git repository outside of the |
293 | Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__, which is | 293 | :term:`Source Directory`, which is |
294 | usually named ``poky``. Also, be sure you are in the | 294 | usually named ``poky``. Also, be sure you are in the |
295 | ``standard/base`` branch. | 295 | ``standard/base`` branch. |
296 | 296 | ||
@@ -317,8 +317,8 @@ section: | |||
317 | 317 | ||
318 | 6. *Create a Local Copy of the Kernel Cache Git Repository:* For | 318 | 6. *Create a Local Copy of the Kernel Cache Git Repository:* For |
319 | simplicity, it is recommended that you create your copy of the kernel | 319 | simplicity, it is recommended that you create your copy of the kernel |
320 | cache Git repository outside of the `Source | 320 | cache Git repository outside of the |
321 | Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__, which is | 321 | :term:`Source Directory`, which is |
322 | usually named ``poky``. Also, for this example, be sure you are in | 322 | usually named ``poky``. Also, for this example, be sure you are in |
323 | the ``yocto-4.12`` branch. | 323 | the ``yocto-4.12`` branch. |
324 | 324 | ||
@@ -483,8 +483,8 @@ ensure the build process uses the appropriate kernel branch. | |||
483 | Although this particular example does not use it, the | 483 | Although this particular example does not use it, the |
484 | :term:`KERNEL_FEATURES` | 484 | :term:`KERNEL_FEATURES` |
485 | variable could be used to enable features specific to the kernel. The | 485 | variable could be used to enable features specific to the kernel. The |
486 | append file points to specific commits in the `Source | 486 | append file points to specific commits in the |
487 | Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__ Git repository and | 487 | :term:`Source Directory` Git repository and |
488 | the ``meta`` Git repository branches to identify the exact kernel needed | 488 | the ``meta`` Git repository branches to identify the exact kernel needed |
489 | to build the BSP. | 489 | to build the BSP. |
490 | 490 | ||
@@ -781,8 +781,8 @@ the "`Getting Ready to Develop Using | |||
781 | 781 | ||
782 | 8. *Build the Image With Your Modified Kernel:* You can now build an | 782 | 8. *Build the Image With Your Modified Kernel:* You can now build an |
783 | image that includes your kernel patches. Execute the following | 783 | image that includes your kernel patches. Execute the following |
784 | command from your `Build | 784 | command from your |
785 | Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__ in the terminal | 785 | :term:`Build Directory` in the terminal |
786 | set up to run BitBake: $ cd ~/poky/build $ bitbake core-image-minimal | 786 | set up to run BitBake: $ cd ~/poky/build $ bitbake core-image-minimal |
787 | 787 | ||
788 | Using Traditional Kernel Development to Patch the Kernel | 788 | Using Traditional Kernel Development to Patch the Kernel |
@@ -1134,8 +1134,7 @@ build system applies fragments on top of and after applying the existing | |||
1134 | defconfig file configurations. | 1134 | defconfig file configurations. |
1135 | 1135 | ||
1136 | Syntactically, the configuration statement is identical to what would | 1136 | Syntactically, the configuration statement is identical to what would |
1137 | appear in the ``.config`` file, which is in the `Build | 1137 | appear in the ``.config`` file, which is in the :term:`Build Directory`. |
1138 | Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__. | ||
1139 | 1138 | ||
1140 | .. note:: | 1139 | .. note:: |
1141 | 1140 | ||
diff --git a/documentation/kernel-dev/kernel-dev-concepts-appx.rst b/documentation/kernel-dev/kernel-dev-concepts-appx.rst index ed1486b65d..cf4c20aaeb 100644 --- a/documentation/kernel-dev/kernel-dev-concepts-appx.rst +++ b/documentation/kernel-dev/kernel-dev-concepts-appx.rst | |||
@@ -320,8 +320,8 @@ tree specific to your kernel from which to generate the new kernel | |||
320 | image. | 320 | image. |
321 | 321 | ||
322 | The following figure shows the temporary file structure created on your | 322 | The following figure shows the temporary file structure created on your |
323 | host system when you build the kernel using Bitbake. This `Build | 323 | host system when you build the kernel using Bitbake. This |
324 | Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__ contains all the | 324 | :term:`Build Directory` contains all the |
325 | source files used during the build. | 325 | source files used during the build. |
326 | 326 | ||
327 | Again, for additional information on the Yocto Project kernel's | 327 | Again, for additional information on the Yocto Project kernel's |
diff --git a/documentation/kernel-dev/kernel-dev-maint-appx.rst b/documentation/kernel-dev/kernel-dev-maint-appx.rst index d76e789d56..c0c0bc260b 100644 --- a/documentation/kernel-dev/kernel-dev-maint-appx.rst +++ b/documentation/kernel-dev/kernel-dev-maint-appx.rst | |||
@@ -222,7 +222,7 @@ functionality. | |||
222 | This behavior means that all the generated files for a particular | 222 | This behavior means that all the generated files for a particular |
223 | machine or BSP are now in the build tree directory. The files include | 223 | machine or BSP are now in the build tree directory. The files include |
224 | the final ``.config`` file, all the ``.o`` files, the ``.a`` files, and | 224 | the final ``.config`` file, all the ``.o`` files, the ``.a`` files, and |
225 | so forth. Since each machine or BSP has its own separate `Build | 225 | so forth. Since each machine or BSP has its own separate |
226 | Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__ in its own separate | 226 | :term:`Build Directory` in its own separate |
227 | branch of the Git repository, you can easily switch between different | 227 | branch of the Git repository, you can easily switch between different |
228 | builds. | 228 | builds. |