| Message ID | 20260126222743.411405-5-daiane.angolini@foundries.io |
|---|---|
| State | New |
| Headers | show |
| Series | [1/5] doc: change some terminology around bitbake-setup | expand |
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
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
On Tue, Jan 27, 2026 at 7:50 AM Alexander Kanavin <alex.kanavin@gmail.com> wrote: > > 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. For this one, I'm really guessing. Because, when I made a "wrong" json file, I got an error that bitbake source is needed (so I added bitbake). But when I drop "sources" completely, nothing is created (and I was expecting at least the top directory and the .conf files) So, saying it's "optional" is not accurate, but saying it's "required" is not accurate either. But I don't quite understand the constraints here. Daiane > > Alex
On Tue, 27 Jan 2026 at 14:27, Daiane Angolini <daiane.angolini@foundries.io> wrote: > For this one, I'm really guessing. Because, when I made a "wrong" json > file, I got an error that bitbake source is needed (so I added > bitbake). > > But when I drop "sources" completely, nothing is created (and I was > expecting at least the top directory and the .conf files) > > So, saying it's "optional" is not accurate, but saying it's "required" > is not accurate either. But I don't quite understand the constraints > here. It's just that these are all not very common corner cases, and they aren't tested. We test the common case, but if behaviour in such special situations doesn't make sense, that can be fixed in the tool itself if there's a need for it. 'configurations' without 'sources' doesn't make sense though, as configurations contain lists of layers and fragments, which are both references into sources . Alex
On Tue, Jan 27, 2026 at 2:47 PM Alexander Kanavin <alex.kanavin@gmail.com> wrote: > > On Tue, 27 Jan 2026 at 14:27, Daiane Angolini > <daiane.angolini@foundries.io> wrote: > > For this one, I'm really guessing. Because, when I made a "wrong" json > > file, I got an error that bitbake source is needed (so I added > > bitbake). > > > > But when I drop "sources" completely, nothing is created (and I was > > expecting at least the top directory and the .conf files) > > > > So, saying it's "optional" is not accurate, but saying it's "required" > > is not accurate either. But I don't quite understand the constraints > > here. > > It's just that these are all not very common corner cases, and they > aren't tested. We test the common case, but if behaviour in such > special situations doesn't make sense, that can be fixed in the tool > itself if there's a need for it. > > 'configurations' without 'sources' doesn't make sense though, as > configurations contain lists of layers and fragments, which are both > references into sources . so, it's required. Daiane > > Alex
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:
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(-)