| Message ID | 20251114-update-bbsetup-doc-v1-1-044070bdffec@bootlin.com |
|---|---|
| State | Accepted, archived |
| Commit | 6f2151a9b4fb3db83fbeb1018a835750799a1356 |
| Headers | show |
| Series | bitbake-setup doc updates | expand |
On Fri, 14 Nov 2025 at 12:12, Antonin Godard via lists.openembedded.org <antonin.godard=bootlin.com@lists.openembedded.org> wrote: > -#. ``bitbake-setup`` is part of the BitBake repository under > - ``./bin/bitbake-setup``. To start, run: > +#. If you haven't already, clone the BitBake repository: > > .. code-block:: shell > > - $ ./bin/bitbake-setup init > + $ git clone https://git.openembedded.org/bitbake Add a note here: bitbake-setup is not coupled to the openembedded or yocto releases that it is setting up, and generally a copy from bitbake master should be used as it aims to be backwards compatible, and yet have the fullest set of features. 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 66c0b0fa68..9ae8ca7fb9 100644 --- a/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst +++ b/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst @@ -25,12 +25,20 @@ the following tasks: Quick Start =========== -#. ``bitbake-setup`` is part of the BitBake repository under - ``./bin/bitbake-setup``. To start, run: +#. If you haven't already, clone the BitBake repository: .. code-block:: shell - $ ./bin/bitbake-setup init + $ git clone https://git.openembedded.org/bitbake + +#. ``bitbake-setup`` is part of the BitBake source tree under + ``./bitbake/bin/bitbake-setup``. + + To start, run: + + .. code-block:: shell + + $ ./bitbake/bin/bitbake-setup init This command will ask you to choose which configurations to use available as part of the default BitBake :term:`generic configurations <generic
Users reading the documentation on the website or else might not have a copy of bitbake yet. It is not straightforward to users that bitbake-setup is part of the source tree and that it is the only location to use it from (for now). Add a step at the beginning of the Quick Start section that shows how to clone bitbake-setup. The default branch (master) will be cloned, which is currently what is recommended. This might be subject to change in the future if bitbake-setup becomes backwards-incompatible. Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> --- .../bitbake-user-manual-environment-setup.rst | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-)