diff mbox series

[docs,5/5] docs: Fix sources as required

Message ID 20260126222743.411405-5-daiane.angolini@foundries.io
State New
Headers show
Series [docs,1/5] doc: change some terminology around bitbake-setup | expand

Commit Message

Daiane Angolini Jan. 26, 2026, 10:27 p.m. UTC
If sources is empty, nothing happens. So let's just not say it's
optional, and let's say the minimum is bitbake source code.

Signed-off-by: Daiane Angolini <daiane.angolini@foundries.io>
---
 .../bitbake-user-manual-environment-setup.rst               | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

Comments

Antonin Godard Jan. 27, 2026, 10:28 a.m. UTC | #1
Hi,

On Mon Jan 26, 2026 at 11:27 PM CET, Daiane Angolini via lists.openembedded.org wrote:
> If sources is empty, nothing happens. So let's just not say it's
> optional, and let's say the minimum is bitbake source code.
>
> Signed-off-by: Daiane Angolini <daiane.angolini@foundries.io>
> ---
>  .../bitbake-user-manual-environment-setup.rst               | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
>
> 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 700e02216..5d6bcbea1 100644
> --- a/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
> +++ b/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
> @@ -671,8 +671,10 @@ They contain the following sections:
>            "description": "OpenEmbedded - 'nodistro' basic configuration"
>        }
>  
> --  ``sources`` (*optional*): sources, such as git repositories that should be provided
> -   under ``layers/`` directory of a :term:`Setup`.
> +-  ``sources``: sources, such as git repositories that should be provided

To align with the rest, this should contain "(**required**)" then

> +   under ``layers/`` directory of a :term:`Setup`. Although the list of sources
> +   can be very flexible, at least BitBake should be cloned to generate a
> +   :term:`Setup`.
>  
>     Example:
>  


Antonin
Alexander Kanavin Jan. 27, 2026, 10:50 a.m. UTC | #2
On Tue, 27 Jan 2026 at 11:28, Antonin Godard via
lists.yoctoproject.org
<antonin.godard=bootlin.com@lists.yoctoproject.org> wrote:
> > +   under ``layers/`` directory of a :term:`Setup`. Although the list of sources
> > +   can be very flexible, at least BitBake should be cloned to generate a
> > +   :term:`Setup`.

Not necessarily. It's an esoteric example, but one could write a list
of sources without bitbake in it, and leave 'configurations' empty. In
this case bitbake-setup will clone/unpack the sources and stop there.

Alex
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 700e02216..5d6bcbea1 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
@@ -671,8 +671,10 @@  They contain the following sections:
           "description": "OpenEmbedded - 'nodistro' basic configuration"
       }
 
--  ``sources`` (*optional*): sources, such as git repositories that should be provided
-   under ``layers/`` directory of a :term:`Setup`.
+-  ``sources``: sources, such as git repositories that should be provided
+   under ``layers/`` directory of a :term:`Setup`. Although the list of sources
+   can be very flexible, at least BitBake should be cloned to generate a
+   :term:`Setup`.
 
    Example: