diff mbox series

[4/5] dev-manual/poky-manual-setup.rst: mention the Source Directory

Message ID 20251224-terms-refresh-v1-4-691329fd038f@bootlin.com
State Superseded
Headers show
Series Redefine terms now that the Poky repository is obsolete | expand

Commit Message

Antonin Godard Dec. 24, 2025, 4:24 p.m. UTC
After switching to the new definition of "Source Directory", i.e. the
base directory for your project (which used to be poky), mention it in
this document on manually setting up the layers for a project. As stated
in terms.rst, use "project" for the directory name.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/dev-manual/poky-manual-setup.rst | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

Comments

Quentin Schulz Jan. 15, 2026, 10:27 a.m. UTC | #1
Hi Antonin,

On 12/24/25 5:24 PM, Antonin Godard via lists.yoctoproject.org wrote:
> After switching to the new definition of "Source Directory", i.e. the
> base directory for your project (which used to be poky), mention it in
> this document on manually setting up the layers for a project. As stated
> in terms.rst, use "project" for the directory name.
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>   documentation/dev-manual/poky-manual-setup.rst | 10 +++++++++-
>   1 file changed, 9 insertions(+), 1 deletion(-)
> 
> diff --git a/documentation/dev-manual/poky-manual-setup.rst b/documentation/dev-manual/poky-manual-setup.rst
> index bcda9d7e7..7ee084007 100644
> --- a/documentation/dev-manual/poky-manual-setup.rst
> +++ b/documentation/dev-manual/poky-manual-setup.rst
> @@ -22,7 +22,15 @@ release or a Long Term Support release.
>   
>   Once you complete the setup instructions for your machine (see the
>   :doc:`/ref-manual/system-requirements` section of the Yocto Project Reference
> -Manual), you need to get a copy of the different :term:`layers <Layer>` needed
> +Manual), create a :term:`Source Directory`: the base directory for your project.
> +We will name it ``project`` in the following sections:
> +

What do you think about:

We will name it ``project`` in the following sections

to

Throughout the documentation, we will use ``project`` as the 
:term:`Source Directory`. Here's how to create it:

?

Otherwise, change ok to me.

Cheers,
Quentin
diff mbox series

Patch

diff --git a/documentation/dev-manual/poky-manual-setup.rst b/documentation/dev-manual/poky-manual-setup.rst
index bcda9d7e7..7ee084007 100644
--- a/documentation/dev-manual/poky-manual-setup.rst
+++ b/documentation/dev-manual/poky-manual-setup.rst
@@ -22,7 +22,15 @@  release or a Long Term Support release.
 
 Once you complete the setup instructions for your machine (see the
 :doc:`/ref-manual/system-requirements` section of the Yocto Project Reference
-Manual), you need to get a copy of the different :term:`layers <Layer>` needed
+Manual), create a :term:`Source Directory`: the base directory for your project.
+We will name it ``project`` in the following sections:
+
+.. code-block:: console
+
+   $ mkdir project
+   $ cd project
+
+You need to get a copy of the different :term:`layers <Layer>` needed
 to setup the :term:`Poky` reference distribution on your build host. Use the
 following commands: