From b44fbe5b1b425b8a8c23e4f0ba80583944ab303a Mon Sep 17 00:00:00 2001 From: Michael Opdenacker Date: Thu, 27 Oct 2022 15:09:08 +0200 Subject: manuals: use references to the "Build Directory" term Replace instances of "Build Directory" and "build directory" (when applicable) by :term:`Build Directory` as already done in most places. Doing this, fix the indentation of the paragraphs with this term. (From yocto-docs rev: dce50679242d39f133e0cde5c8483b5e69f3eb54) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie --- documentation/kernel-dev/common.rst | 45 ++++++++++++------------------ documentation/kernel-dev/concepts-appx.rst | 3 +- documentation/kernel-dev/intro.rst | 4 +-- documentation/kernel-dev/maint-appx.rst | 5 ++-- 4 files changed, 23 insertions(+), 34 deletions(-) (limited to 'documentation/kernel-dev') diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst index 0a1819ceae..690f61110b 100644 --- a/documentation/kernel-dev/common.rst +++ b/documentation/kernel-dev/common.rst @@ -66,19 +66,15 @@ section: (i.e. ``poky``) have been cloned using Git and the local repository is named "poky". -2. *Prepare Your local.conf File:* By default, the - :term:`MACHINE` variable is set to - "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 +2. *Prepare Your local.conf File:* By default, the :term:`MACHINE` variable + is set to "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 :term:`MACHINE` variable appropriately in your ``conf/local.conf`` file - found in the - :term:`Build Directory` (i.e. - ``poky/build`` in this example). + 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 - to set the - :term:`MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS` - variable to include kernel modules. + to set the :term:`MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS` variable to include + kernel modules. In this example we wish to build for qemux86 so we must set the :term:`MACHINE` variable to "qemux86" and also add the "kernel-modules". @@ -186,14 +182,11 @@ section: (i.e. ``poky``) have been cloned using Git and the local repository is named "poky". -2. *Prepare Your local.conf File:* By default, the - :term:`MACHINE` variable is set to - "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 - :term:`MACHINE` variable appropriately in your ``conf/local.conf`` file - found in the - :term:`Build Directory` (i.e. - ``poky/build`` in this example). +2. *Prepare Your local.conf File:* By default, the :term:`MACHINE` variable is + set to "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 :term:`MACHINE` + variable appropriately in your ``conf/local.conf`` file 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 to set the @@ -836,8 +829,7 @@ the ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" Se 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 - :term:`Build Directory` in the terminal + command from your :term:`Build Directory` in the terminal set up to run BitBake:: $ cd poky/build @@ -1057,9 +1049,8 @@ To use the ``menuconfig`` tool in the Yocto Project development environment, you must do the following: - Because you launch ``menuconfig`` using BitBake, you must be sure to - set up your environment by running the - :ref:`structure-core-script` script found in - the :term:`Build Directory`. + set up your environment by running the :ref:`structure-core-script` script + found in the :term:`Build Directory`. - You must be sure of the state of your build's configuration in the :term:`Source Directory`. @@ -1111,10 +1102,10 @@ can find the option under "Processor Type and Features". To deselect Multi-Processing Support" and enter "N" to clear the asterisk. When you are finished, exit out and save the change. -Saving the selections updates the ``.config`` configuration file. This -is the file that the OpenEmbedded build system uses to configure the -kernel during the build. You can find and examine this file in the Build -Directory in ``tmp/work/``. The actual ``.config`` is located in the +Saving the selections updates the ``.config`` configuration file. This is the +file that the OpenEmbedded build system uses to configure the kernel during +the build. You can find and examine this file in the :term:`Build Directory` +in ``tmp/work/``. The actual ``.config`` is located in the area where the specific kernel is built. For example, if you were building a Linux Yocto kernel based on the ``linux-yocto-4.12`` kernel and you were building a QEMU image targeted for ``x86`` architecture, diff --git a/documentation/kernel-dev/concepts-appx.rst b/documentation/kernel-dev/concepts-appx.rst index 63c5124a57..6a2fe4bb0b 100644 --- a/documentation/kernel-dev/concepts-appx.rst +++ b/documentation/kernel-dev/concepts-appx.rst @@ -319,8 +319,7 @@ image. The following figure shows the temporary file structure created on your host system when you build the kernel using BitBake. This -:term:`Build Directory` contains all the -source files used during the build. +:term:`Build Directory` contains all the source files used during the build. .. image:: figures/kernel-overview-2-generic.png :align: center diff --git a/documentation/kernel-dev/intro.rst b/documentation/kernel-dev/intro.rst index 4ff4dc7d35..267b7e7797 100644 --- a/documentation/kernel-dev/intro.rst +++ b/documentation/kernel-dev/intro.rst @@ -134,7 +134,7 @@ general information and references for further information. 3. *Make Changes to the Kernel Source Code if applicable:* Modifying the kernel does not always mean directly changing source files. However, if you have to do this, you make the changes to the files in the - Yocto's Build Directory if you are using ``devtool``. For more + Yocto's :term:`Build Directory` if you are using ``devtool``. For more information, see the ":ref:`kernel-dev/common:using \`\`devtool\`\` to patch the kernel`" section. @@ -155,7 +155,7 @@ general information and references for further information. .. note:: Try to resist the temptation to directly edit an existing ``.config`` - file, which is found in the Build Directory among the source code + file, which is found in the :term:`Build Directory` among the source code used for the build. Doing so, can produce unexpected results when the OpenEmbedded build system regenerates the configuration file. diff --git a/documentation/kernel-dev/maint-appx.rst b/documentation/kernel-dev/maint-appx.rst index d968c856f6..6aa2fb7cf1 100644 --- a/documentation/kernel-dev/maint-appx.rst +++ b/documentation/kernel-dev/maint-appx.rst @@ -229,6 +229,5 @@ 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 -:term:`Build Directory` in its own separate -branch of the Git repository, you can easily switch between different -builds. +: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