From 424567d629b08785a6594d16427ee0fa8c31f384 Mon Sep 17 00:00:00 2001 From: Nicolas Dechesne Date: Mon, 27 Jul 2020 17:38:09 +0200 Subject: 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 Signed-off-by: Richard Purdie --- documentation/kernel-dev/kernel-dev-common.rst | 31 +++++++++++----------- .../kernel-dev/kernel-dev-concepts-appx.rst | 4 +-- documentation/kernel-dev/kernel-dev-maint-appx.rst | 4 +-- 3 files changed, 19 insertions(+), 20 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 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 set up, see the "`Preparing the Build Host <&YOCTO_DOCS_DEV_URL;#dev-preparing-the-build-host>`__" section in the Yocto Project Development Tasks Manual. Part of preparing the system -is creating a local Git repository of the `Source -Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__ (``poky``) on your +is creating a local Git repository of the +:term:`Source Directory` (``poky``) on your system. Follow the steps in the "`Cloning the ``poky`` Repository <&YOCTO_DOCS_DEV_URL;#cloning-the-poky-repository>`__" section in the Yocto Project Development Tasks Manual to set up your @@ -76,8 +76,8 @@ section: "qemux86-64", which is fine if you are building for the QEMU emulator in 64-bit mode. However, if you are not, you need to set the ``MACHINE`` variable appropriately in your ``conf/local.conf`` file - found in the `Build - Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__ (i.e. + found in the + :term:`Build Directory` (i.e. ``~/poky/build`` in this example). Also, since you are preparing to work on the kernel image, you need @@ -240,8 +240,8 @@ section: "qemux86-64", which is fine if you are building for the QEMU emulator in 64-bit mode. However, if you are not, you need to set the ``MACHINE`` variable appropriately in your ``conf/local.conf`` file - found in the `Build - Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__ (i.e. + found in the + :term:`Build Directory` (i.e. ``~/poky/build`` in this example). Also, since you are preparing to work on the kernel image, you need @@ -289,8 +289,8 @@ section: ` <&YOCTO_GIT_URL;>`__. For simplicity, it is recommended that you create your copy of the - kernel Git repository outside of the `Source - Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__, which is + kernel Git repository outside of the + :term:`Source Directory`, which is usually named ``poky``. Also, be sure you are in the ``standard/base`` branch. @@ -317,8 +317,8 @@ section: 6. *Create a Local Copy of the Kernel Cache Git Repository:* For simplicity, it is recommended that you create your copy of the kernel - cache Git repository outside of the `Source - Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__, which is + cache Git repository outside of the + :term:`Source Directory`, which is usually named ``poky``. Also, for this example, be sure you are in the ``yocto-4.12`` branch. @@ -483,8 +483,8 @@ ensure the build process uses the appropriate kernel branch. Although this particular example does not use it, the :term:`KERNEL_FEATURES` variable could be used to enable features specific to the kernel. The -append file points to specific commits in the `Source -Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__ Git repository and +append file points to specific commits in the +:term:`Source Directory` Git repository and the ``meta`` Git repository branches to identify the exact kernel needed to build the BSP. @@ -781,8 +781,8 @@ the "`Getting Ready to Develop Using 8. *Build the Image With Your Modified Kernel:* You can now build an image that includes your kernel patches. Execute the following - command from your `Build - Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__ in the terminal + command from your + :term:`Build Directory` in the terminal set up to run BitBake: $ cd ~/poky/build $ bitbake core-image-minimal Using Traditional Kernel Development to Patch the Kernel @@ -1134,8 +1134,7 @@ build system applies fragments on top of and after applying the existing defconfig file configurations. Syntactically, the configuration statement is identical to what would -appear in the ``.config`` file, which is in the `Build -Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__. +appear in the ``.config`` file, which is in the :term:`Build Directory`. .. note:: 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 image. The following figure shows the temporary file structure created on your -host system when you build the kernel using Bitbake. This `Build -Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__ contains all the +host system when you build the kernel using Bitbake. This +:term:`Build Directory` contains all the source files used during the build. 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. This behavior means that all the generated files for a particular machine or BSP are now in the build tree directory. The files include the final ``.config`` file, all the ``.o`` files, the ``.a`` files, and -so forth. Since each machine or BSP has its own separate `Build -Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__ in its own separate +so forth. Since each machine or BSP has its own separate +:term:`Build Directory` in its own separate branch of the Git repository, you can easily switch between different builds. -- cgit v1.2.3-54-g00ecf