From: Antonin Godard <antonin.godard@bootlin.com>
To: docs@lists.yoctoproject.org
Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com>,
Antonin Godard <antonin.godard@bootlin.com>
Subject: [PATCH 1/5] ref-manual/terms.rst: refresh the Build Directory definition
Date: Wed, 24 Dec 2025 17:24:16 +0100 [thread overview]
Message-ID: <20251224-terms-refresh-v1-1-691329fd038f@bootlin.com> (raw)
In-Reply-To: <20251224-terms-refresh-v1-0-691329fd038f@bootlin.com>
After the Poky repository obsolescence, refresh the build directory
definition. Fix the formatting and indenting issues while at it.
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
documentation/ref-manual/terms.rst | 46 +++++++++++++++++++++-----------------
1 file changed, 25 insertions(+), 21 deletions(-)
diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst
index 6a9f88061..4b9b6ed88 100644
--- a/documentation/ref-manual/terms.rst
+++ b/documentation/ref-manual/terms.rst
@@ -63,36 +63,39 @@ universal, the list includes them just in case:
This term refers to the area used by the OpenEmbedded build system for
builds. The area is created when you ``source`` the setup environment
script that is found in the Source Directory
- (i.e. :ref:`ref-manual/structure:``oe-init-build-env```). The
+ (i.e. :ref:`ref-manual/structure:``oe-init-build-env```, or
+ ``init-build-env`` when using :doc:`bitbake-setup
+ <bitbake:bitbake-user-manual/bitbake-user-manual-environment-setup>`). The
:term:`TOPDIR` variable points to the :term:`Build Directory`.
- You have a lot of flexibility when creating the :term:`Build Directory`.
+ When setting up the build manually (see :doc:`/dev-manual/poky-manual-setup`),
+ you have a lot of flexibility when creating the :term:`Build Directory`.
Here are some examples that show how to create the directory. The
- examples assume your :term:`Source Directory` is named ``poky``:
+ examples assume your :term:`Source Directory` is named ``project``:
- - Create the :term:`Build Directory` inside your Source Directory and let
- the name of the :term:`Build Directory` default to ``build``:
+ - Create the :term:`Build Directory` inside your Source Directory and let
+ the name of the :term:`Build Directory` default to ``build``:
- .. code-block:: shell
+ .. code-block:: console
- $ cd poky
- $ source oe-init-build-env
+ $ cd project
+ $ source layers/openembedded-core/oe-init-build-env
- - Create the :term:`Build Directory` inside your home directory and
- specifically name it ``test-builds``:
+ - Create the :term:`Build Directory` inside your home directory and
+ specifically name it ``test-builds``:
- .. code-block:: shell
+ .. code-block:: console
- $ source poky/oe-init-build-env test-builds
+ $ source project/layers/openembedded-core/oe-init-build-env test-builds
- - Provide a directory path and specifically name the
- :term:`Build Directory`. Any intermediate folders in the pathname
- must exist. This next example creates a :term:`Build Directory`
- named ``YP-&DISTRO;`` within the existing directory ``mybuilds``:
+ - Provide a directory path and specifically name the
+ :term:`Build Directory`. Any intermediate folders in the pathname
+ must exist. This next example creates a :term:`Build Directory`
+ named ``YP-&DISTRO;`` within the existing directory ``mybuilds``:
- .. code-block:: shell
+ .. code-block:: shell
- $ source poky/oe-init-build-env mybuilds/YP-&DISTRO;
+ $ source project/layers/openembedded-core/oe-init-build-env mybuilds/YP-&DISTRO;
.. note::
@@ -100,9 +103,10 @@ universal, the list includes them just in case:
temporary directory the build system uses for its work. :term:`TMPDIR` cannot
be under NFS. Thus, by default, the :term:`Build Directory` cannot be under
NFS. However, if you need the :term:`Build Directory` to be under NFS, you can
- set this up by setting :term:`TMPDIR` in your ``local.conf`` file to use a local
- drive. Doing so effectively separates :term:`TMPDIR` from :term:`TOPDIR`, which is the
- :term:`Build Directory`.
+ set this up by setting :term:`TMPDIR` in your
+ :ref:`structure-build-conf-site.conf` file to use a local drive. Doing
+ so effectively separates :term:`TMPDIR` from :term:`TOPDIR`, which is
+ the :term:`Build Directory`.
:term:`Build Host`
The system used to build images in a Yocto Project Development
--
2.51.0
next prev parent reply other threads:[~2025-12-24 16:24 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-12-24 16:24 [PATCH 0/5] Redefine terms now that the Poky repository is obsolete Antonin Godard
2025-12-24 16:24 ` Antonin Godard [this message]
2026-01-15 10:13 ` [docs] [PATCH 1/5] ref-manual/terms.rst: refresh the Build Directory definition Quentin Schulz
2025-12-24 16:24 ` [PATCH 2/5] ref-manual/terms.rst: refresh the OpenEmbedded-Core definition Antonin Godard
2026-01-15 10:15 ` [docs] " Quentin Schulz
2025-12-24 16:24 ` [PATCH 3/5] ref-manual/terms.rst: simplify the Source Directory definition Antonin Godard
2026-01-15 10:23 ` [docs] " Quentin Schulz
2025-12-24 16:24 ` [PATCH 4/5] dev-manual/poky-manual-setup.rst: mention the Source Directory Antonin Godard
2026-01-15 10:27 ` [docs] " Quentin Schulz
2025-12-24 16:24 ` [PATCH 5/5] ref-manual/terms.rst: refresh the OpenEmbedded build system definition Antonin Godard
2026-01-08 15:04 ` [docs] " Paul Barker
2026-01-09 10:10 ` Antonin Godard
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20251224-terms-refresh-v1-1-691329fd038f@bootlin.com \
--to=antonin.godard@bootlin.com \
--cc=docs@lists.yoctoproject.org \
--cc=thomas.petazzoni@bootlin.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox