Re: [docs] [PATCH 1/5] ref-manual/terms.rst: refresh the Build Directory definition

Quentin Schulz
2026-01-15T10:14:02Z

Hi Antonin,

On 12/24/25 5:24 PM, Antonin Godard via lists.yoctoproject.org wrote:
> 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

I would either end each item (except the last) in the list with "or" or
start each item (except the first) with "or, " so it's clear you only
need to follow one or the other.

> + 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
>

How is that creating the build directory within my home directory?

Looks ok to me otherwise.

Cheers,
Quentin