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 v2 3/5] ref-manual/terms.rst: simplify the Source Directory definition
Date: Tue, 20 Jan 2026 16:17:02 +0100 [thread overview]
Message-ID: <20260120-terms-refresh-v2-3-fa49d15b209f@bootlin.com> (raw)
In-Reply-To: <20260120-terms-refresh-v2-0-fa49d15b209f@bootlin.com>
Now that we no longer have Poky around, simplify the Source Directory
definition:
- Make references to existing documents that show how to create this
Source Directory.
- This directory contains sources, the layout in which they are
presented does not matter so much, as it can be different and/or
freeform depending on whether we use bitbake-setup or not.
The definition chooses "project" as the name of the source directory
and is the one that should be used when showing examples in the
documentation.
A typical Source Directory would look like the following:
project/
├── build/
└── layers/
Other parts of the documentation referencing to this as the Poky
repository still have to be updated.
This will also mean that this definition will be used a lot less across
the documentation: in most cases, when the "Source Directory" is
referenced as the Poky repository, it can be replaced by
OpenEmbedded-Core, Bitbake, the documentation, or meta-yocto. We'll keep
this definition around regardless, as it can be useful to denote this
group of directories in a more general sense.
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
documentation/ref-manual/terms.rst | 79 +++++++++++++++-----------------------
1 file changed, 31 insertions(+), 48 deletions(-)
diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst
index d908af4ae..ab8eb6123 100644
--- a/documentation/ref-manual/terms.rst
+++ b/documentation/ref-manual/terms.rst
@@ -526,20 +526,36 @@ universal, the list includes them just in case:
a software bill of materials`" section of the Development Tasks manual.
:term:`Source Directory`
- This term refers to the directory structure
- created as a result of creating a local copy of the ``poky`` Git
- repository ``git://git.yoctoproject.org/poky`` or expanding a
- released ``poky`` tarball.
+ This term refers to the directory structure created as a result of setting
+ up your environment to build images with the Yocto Project, which can be
+ done in two ways:
- .. note::
+ - Using the ``bitbake-setup`` command-line utility (see :doc:`Setting Up
+ The Environment With bitbake-setup
+ <bitbake:bitbake-user-manual/bitbake-user-manual-environment-setup>`).
+
+ - Or manually setting up the :term:`Layers <Layer>` (see
+ :doc:`/dev-manual/poky-manual-setup`).
+
+ In either case, the result will be a set of :term:`Layers <Layer>` and a
+ :term:`Build Directory`: this is the Source Directory for your build. The
+ documentation usually denotes this directory with the name "project".
+
+ A typical layout for the :term:`Source Directory` would be:
+
+ .. code-block:: text
+
+ project/
+ ├── build/
+ └── layers/
- Creating a local copy of the
- poky
- Git repository is the recommended method for setting up your
- Source Directory.
+ Where the ``layers/`` directory corresponds to the directory containing
+ :term:`layers <Layer>` for your project, and the ``build/`` directory
+ corresponds to the :term:`Build Directory`.
- Sometimes you might hear the term "poky directory" used to refer to
- this directory structure.
+ We present a :term:`Source Directory` structure and its components in
+ details in the :doc:`/ref-manual/structure` section of the Yocto Project
+ Reference Manual.
.. note::
@@ -547,43 +563,10 @@ universal, the list includes them just in case:
names that contain spaces. Be sure that the Source Directory you
use does not contain these types of names.
- The Source Directory contains BitBake, Documentation, Metadata and
- other files that all support the Yocto Project. Consequently, you
- must have the Source Directory in place on your development system in
- order to do any development using the Yocto Project.
-
- When you create a local copy of the Git repository, you can name the
- repository anything you like. Throughout much of the documentation,
- "poky" is used as the name of the top-level folder of the local copy
- of the poky Git repository. So, for example, cloning the ``poky`` Git
- repository results in a local Git repository whose top-level folder
- is also named "poky".
-
- While it is not recommended that you use tarball extraction to set up
- the Source Directory, if you do, the top-level directory name of the
- Source Directory is derived from the Yocto Project release tarball.
- For example, downloading and unpacking poky tarballs from
- :yocto_dl:`/releases/yocto/&DISTRO_REL_LATEST_TAG;/`
- results in a Source Directory whose root folder is named poky.
-
-
- It is important to understand the differences between the Source
- Directory created by unpacking a released tarball as compared to
- cloning ``git://git.yoctoproject.org/poky``. When you unpack a
- tarball, you have an exact copy of the files based on the time of
- release --- a fixed release point. Any changes you make to your local
- files in the Source Directory are on top of the release and will
- remain local only. On the other hand, when you clone the ``poky`` Git
- repository, you have an active development repository with access to
- the upstream repository's branches and tags. In this case, any local
- changes you make to the local Source Directory can be later applied
- to active development branches of the upstream ``poky`` Git
- repository.
-
- For more information on concepts related to Git repositories,
- branches, and tags, see the
- ":ref:`overview-manual/development-environment:repositories, tags, and branches`"
- section in the Yocto Project Overview and Concepts Manual.
+ The Source Directory contains BitBake, OpenEmbedded-Core (OE-Core),
+ Documentation, Metadata and other files that all support the Yocto Project.
+ Consequently, you must have the Source Directory in place on your
+ development system in order to do any development using the Yocto Project.
:term:`SPDX`
This term means *Software Package Data Exchange*, and is used as an open
--
2.52.0
next prev parent reply other threads:[~2026-01-20 15:17 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-01-20 15:16 [PATCH v2 0/5] Redefine terms now that the Poky repository is obsolete Antonin Godard
2026-01-20 15:17 ` [PATCH v2 1/5] ref-manual/terms.rst: refresh the Build Directory definition Antonin Godard
2026-01-20 16:36 ` [docs] " Quentin Schulz
2026-01-20 15:17 ` [PATCH v2 2/5] ref-manual/terms.rst: refresh the OpenEmbedded-Core definition Antonin Godard
2026-01-20 15:17 ` Antonin Godard [this message]
2026-01-20 16:42 ` [docs] [PATCH v2 3/5] ref-manual/terms.rst: simplify the Source Directory definition Quentin Schulz
2026-01-20 16:44 ` Quentin Schulz
2026-01-21 11:09 ` Antonin Godard
2026-01-20 15:17 ` [PATCH v2 4/5] dev-manual/poky-manual-setup.rst: mention the Source Directory Antonin Godard
2026-01-20 16:44 ` [docs] " Quentin Schulz
2026-01-20 15:17 ` [PATCH v2 5/5] ref-manual/terms.rst: refresh the OpenEmbedded build system definition Antonin Godard
2026-01-20 16:46 ` [docs] " Quentin Schulz
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=20260120-terms-refresh-v2-3-fa49d15b209f@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