diff mbox series

doc/bitbake-setup: extend doc of "path" option

Message ID 20251127-bbsetup-path-option-v1-1-2d2565eb927c@bootlin.com
State New
Headers show
Series doc/bitbake-setup: extend doc of "path" option | expand

Commit Message

Antonin Godard Nov. 27, 2025, 8:56 a.m. UTC
The commit 6727d0852f3f ("bitbake-setup: make "path" optional") changed
the behavior of this bitbake-setup JSON option. Document it.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)


---
base-commit: 6ee4df8ab58e0175b43106d8a6cbac1f6ab8d022
change-id: 20251127-bbsetup-path-option-ca416ef22fa8

Comments

Yoann Congal Nov. 27, 2025, 9:10 a.m. UTC | #1
Le jeu. 27 nov. 2025 à 09:56, Antonin Godard via lists.openembedded.org
<antonin.godard=bootlin.com@lists.openembedded.org> a écrit :

> The commit 6727d0852f3f ("bitbake-setup: make "path" optional") changed
> the behavior of this bitbake-setup JSON option. Document it.
>
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
>

Thanks Antonin!


> ---
>  doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
>
> diff --git
> a/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
> b/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
> index 2b8051bcb4..edbc749ad6 100644
> --- a/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
> +++ b/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
> @@ -688,7 +688,9 @@ They contain the following sections:
>     -  ``branch`` (**required**): the Git branch, used to check that the
>        specified ``rev`` is indeed on that branch.
>
> -   -  ``path`` is where the source is extracted.
> +   -  ``path`` (*optional*): where the source is extracted, relative to
> the
> +      ``layers/`` directory of a :term:`Setup`. If unspecified, the name
> of the
> +      source is used.
>
>  -  ``expires`` (*optional*): Expiration date of the configuration. This
> date
>     should be in :wikipedia:`ISO 8601 <ISO_8601>` format
> (``YYYY-MM-DDTHH:MM:SS``).
>
> ---
> base-commit: 6ee4df8ab58e0175b43106d8a6cbac1f6ab8d022
> change-id: 20251127-bbsetup-path-option-ca416ef22fa8
>
>
> -=-=-=-=-=-=-=-=-=-=-=-
> Links: You receive all messages sent to this group.
> View/Reply Online (#18497):
> https://lists.openembedded.org/g/bitbake-devel/message/18497
> Mute This Topic: https://lists.openembedded.org/mt/116498233/4316185
> Group Owner: bitbake-devel+owner@lists.openembedded.org
> Unsubscribe: https://lists.openembedded.org/g/bitbake-devel/unsub [
> yoann.congal@smile.fr]
> -=-=-=-=-=-=-=-=-=-=-=-
>
>
diff mbox series

Patch

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst b/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
index 2b8051bcb4..edbc749ad6 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
@@ -688,7 +688,9 @@  They contain the following sections:
    -  ``branch`` (**required**): the Git branch, used to check that the
       specified ``rev`` is indeed on that branch.
 
-   -  ``path`` is where the source is extracted.
+   -  ``path`` (*optional*): where the source is extracted, relative to the
+      ``layers/`` directory of a :term:`Setup`. If unspecified, the name of the
+      source is used.
 
 -  ``expires`` (*optional*): Expiration date of the configuration. This date
    should be in :wikipedia:`ISO 8601 <ISO_8601>` format (``YYYY-MM-DDTHH:MM:SS``).