mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-06-01 13:09:50 +00:00
Code Issues Projects Releases Wiki Activity

manuals: use references to the "Build Directory" term

Browse Source 
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 <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Michael Opdenacker
2022-10-27 15:09:08 +02:00
committed by Richard Purdie
parent 50458d9238
commit b44fbe5b1b
27 changed files with 294 additions and 376 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/ref-manual/variables.rst
+28 -35
View File
@@ -260,9 +260,9 @@ system and gives an overview of their function and contents.
https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview
:term:`B`
The directory within the :term:`Build Directory` in
which the OpenEmbedded build system places generated objects during a
recipe's build process. By default, this directory is the same as the
The directory within the :term:`Build Directory` in which the
OpenEmbedded build system places generated objects during a recipe's
build process. By default, this directory is the same as the
:term:`S` directory, which is defined as::
S = "${WORKDIR}/${BP}"
@@ -903,12 +903,11 @@ system and gives an overview of their function and contents.
The default value is an empty string ("").
:term:`BUILDDIR`
Points to the location of the :term:`Build Directory`.
You can define this directory indirectly through the
:ref:`structure-core-script` script by passing in a Build
Directory path when you run the script. If you run the script and do
not provide a Build Directory path, the :term:`BUILDDIR` defaults to
``build`` in the current directory.
Points to the location of the :term:`Build Directory`. You can define
this directory indirectly through the :ref:`structure-core-script` script
by passing in a :term:`Build Directory` path when you run the script. If
you run the script and do not provide a :term:`Build Directory` path, the
:term:`BUILDDIR` defaults to ``build`` in the current directory.
:term:`BUILDHISTORY_COMMIT`
When inheriting the :ref:`buildhistory <ref-classes-buildhistory>`
@@ -1712,8 +1711,7 @@ system and gives an overview of their function and contents.
Points to the general area that the OpenEmbedded build system uses to
place images, packages, SDKs, and other output files that are ready
to be used outside of the build system. By default, this directory
resides within the :term:`Build Directory` as
``${TMPDIR}/deploy``.
resides within the :term:`Build Directory` as ``${TMPDIR}/deploy``.
For more information on the structure of the Build Directory, see
":ref:`ref-manual/structure:the build directory --- \`\`build/\`\``" section.
@@ -1759,7 +1757,7 @@ system and gives an overview of their function and contents.
with the contents of :term:`IMGDEPLOYDIR` by the :ref:`image
<ref-classes-image>` class.
For more information on the structure of the Build Directory, see
For more information on the structure of the :term:`Build Directory`, see
":ref:`ref-manual/structure:the build directory --- \`\`build/\`\``" section.
For more detail on the contents of the ``deploy`` directory, see the
":ref:`overview-manual/concepts:images`" and
@@ -2042,8 +2040,7 @@ system and gives an overview of their function and contents.
You can set this directory by defining the :term:`DL_DIR` variable in the
``conf/local.conf`` file. This directory is self-maintaining and you
should not have to touch it. By default, the directory is
``downloads`` in the :term:`Build Directory`.
::
``downloads`` in the :term:`Build Directory`::
#DL_DIR ?= "${TOPDIR}/downloads"
@@ -2264,8 +2261,8 @@ system and gives an overview of their function and contents.
class, this variable points to the directory in which the recipe's
source code is built, which is outside of the OpenEmbedded build
system. When set, this variable sets the :term:`B` variable,
which is what the OpenEmbedded build system uses to locate the Build
Directory.
which is what the OpenEmbedded build system uses to locate the
:term:`Build Directory`.
See the ":ref:`ref-classes-externalsrc`" section for details. You
can also find information on how to use this variable in the
@@ -2285,9 +2282,8 @@ system and gives an overview of their function and contents.
more than one feature, separate them with a space.
Typically, you configure this variable in your ``local.conf`` file,
which is found in the :term:`Build Directory`.
Although you can use this variable from within a recipe, best
practices dictate that you do not.
which is found in the :term:`Build Directory`. Although you can use this
variable from within a recipe, best practices dictate that you do not.
.. note::
@@ -2684,10 +2680,9 @@ system and gives an overview of their function and contents.
You define the :term:`FILESYSTEM_PERMS_TABLES` variable in the
``conf/local.conf`` file, which is found in the :term:`Build Directory`,
to point to your custom
``fs-perms.txt``. You can specify more than a single file permissions
setting table. The paths you specify to these files must be defined
within the :term:`BBPATH` variable.
to point to your custom ``fs-perms.txt``. You can specify more than a
single file permissions setting table. The paths you specify to these
files must be defined within the :term:`BBPATH` variable.
For guidance on how to create your own file permissions settings
table file, examine the existing ``fs-perms.txt``.
@@ -6747,7 +6742,7 @@ system and gives an overview of their function and contents.
to find the unpacked source.
As an example, assume a :term:`Source Directory`
top-level folder named ``poky`` and a default Build Directory at
top-level folder named ``poky`` and a default :term:`Build Directory` at
``poky/build``. In this case, the work directory the build system
uses to keep the unpacked recipe for ``db`` is the following::
@@ -6792,7 +6787,7 @@ system and gives an overview of their function and contents.
:term:`SDK_CUSTOM_TEMPLATECONF`
When building the extensible SDK, if :term:`SDK_CUSTOM_TEMPLATECONF` is set to
"1" and a ``conf/templateconf.cfg`` file exists in the build directory
"1" and a ``conf/templateconf.cfg`` file exists in the :term:`Build Directory`
(:term:`TOPDIR`) then this will be copied into the SDK.
:term:`SDK_DEPLOY`
@@ -7195,8 +7190,7 @@ system and gives an overview of their function and contents.
To enable file removal, set the variable to "1" in your
``conf/local.conf`` configuration file in your:
:term:`Build Directory`.
::
:term:`Build Directory`::
SKIP_FILEDEPS = "1"
@@ -8126,12 +8120,11 @@ system and gives an overview of their function and contents.
You can select "glibc", "musl", "newlib", or "baremetal".
:term:`TCLIBCAPPEND`
Specifies a suffix to be appended onto the
:term:`TMPDIR` value. The suffix identifies the
``libc`` variant for building. When you are building for multiple
variants with the same :term:`Build Directory`, this
mechanism ensures that output for different ``libc`` variants is kept
separate to avoid potential conflicts.
Specifies a suffix to be appended onto the :term:`TMPDIR` value. The
suffix identifies the ``libc`` variant for building. When you are
building for multiple variants with the same :term:`Build Directory`,
this mechanism ensures that output for different ``libc`` variants is
kept separate to avoid potential conflicts.
In the ``defaultsetup.conf`` file, the default value of
:term:`TCLIBCAPPEND` is "-${TCLIBC}". However, distros such as poky,
@@ -8419,7 +8412,7 @@ system and gives an overview of their function and contents.
#TMPDIR = "${TOPDIR}/tmp"
An example use for this scenario is to set :term:`TMPDIR` to a local disk,
which does not use NFS, while having the Build Directory use NFS.
which does not use NFS, while having the :term:`Build Directory` use NFS.
The filesystem used by :term:`TMPDIR` must have standard filesystem
semantics (i.e. mixed-case files are unique, POSIX file locking, and
@@ -9105,7 +9098,7 @@ system and gives an overview of their function and contents.
- :term:`PR`: The recipe revision
As an example, assume a Source Directory top-level folder name
``poky``, a default Build Directory at ``poky/build``, and a
``poky``, a default :term:`Build Directory` at ``poky/build``, and a
``qemux86-poky-linux`` machine target system. Furthermore, suppose
your recipe is named ``foo_1.3.0-r0.bb``. In this case, the work
directory the build system uses to build the package would be as