From: Antonin Godard <antonin.godard@bootlin.com>
To: docs@lists.yoctoproject.org
Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com>,
Antonin Godard <antonin.godard@bootlin.com>
Subject: [PATCH 1/2] brief-yoctoprojectqs/index.rst: use pip to install bitbake-setup
Date: Tue, 11 Aug 2026 11:55:43 +0200 [thread overview]
Message-ID: <20260811-bitbake-setup-pip-v1-1-0c8b350017e4@bootlin.com> (raw)
In-Reply-To: <20260811-bitbake-setup-pip-v1-0-0c8b350017e4@bootlin.com>
bitbake-setup is now available on Pypi[1], so let's use it instead of
a clone of bitbake to use the CLI tool. Refresh commands in consequence.
Keep git clone instructions in a note as an alternative way of setting
things up.
[1]: https://pypi.org/project/bitbake-setup/
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
documentation/brief-yoctoprojectqs/index.rst | 28 ++++++++++++++++++++--------
1 file changed, 20 insertions(+), 8 deletions(-)
diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst
index 2ffa3a6d8..5ecc11791 100644
--- a/documentation/brief-yoctoprojectqs/index.rst
+++ b/documentation/brief-yoctoprojectqs/index.rst
@@ -84,23 +84,35 @@ Build Host Packages
see the :ref:`ref-manual/system-requirements:required packages for the build host`
section in the Yocto Project Reference Manual.
-Use Git to clone bitbake-setup
-==============================
+Install and use bitbake-setup
+=============================
Once you complete the setup instructions for your machine, you need to
get a copy of the ``bitbake-setup`` tool to set up the :term:`Poky` reference
-distribution on your build host. Use the following commands to clone
-the bitbake repository.
+distribution on your :term:`build host`. Use the following commands to install
+the tool in a Python `virtual environment <https://docs.python.org/3/library/venv.html>`__:
.. code-block:: console
- $ git clone https://git.openembedded.org/bitbake
+ $ python3 -m venv --clear ./bitbake-setup-venv
+ $ . ./bitbake-setup-venv/bin/activate
+ $ pip install bitbake-setup
+
+.. note::
+
+ The ``bitbake-setup`` tool can also be used from the :term:`BitBake`
+ repository directly:
+
+ .. code-block:: console
+
+ $ git clone https://git.openembedded.org/bitbake ./bitbake
+ $ ./bitbake/bin/bitbake-setup ...
Setup a build environment with the following command:
.. code-block:: console
- $ ./bitbake/bin/bitbake-setup init
+ $ bitbake-setup init
By default, this will set up a top directory in the current directory.
@@ -109,7 +121,7 @@ If you prefer to set up your builds in a different top directory, for example
.. code-block:: console
- $ ./bitbake/bin/bitbake-setup settings set --global default top-dir-prefix $HOME
+ $ bitbake-setup settings set --global default top-dir-prefix $HOME
.. note::
@@ -183,7 +195,7 @@ differ from the examples below.
.. code-block:: console
- $ ./bitbake/bin/bitbake-setup init --non-interactive poky-master poky distro/poky machine/qemux86-64
+ $ bitbake-setup init --non-interactive poky-master poky distro/poky machine/qemux86-64
The ``init`` command creates a new :term:`bitbake:Setup` in the
:term:`bitbake:top directory`. The default name is derived from the selected
--
2.55.0
next prev parent reply other threads:[~2026-08-11 9:56 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-08-11 9:55 [PATCH 0/2] Quick Build: use pip for bitbake-setup (and a typo fix) Antonin Godard
2026-08-11 9:55 ` Antonin Godard [this message]
2026-08-11 10:22 ` [docs] [PATCH 1/2] brief-yoctoprojectqs/index.rst: use pip to install bitbake-setup Alexander Kanavin
2026-08-11 13:21 ` Antonin Godard
2026-08-11 9:55 ` [PATCH 2/2] brief-yoctoprojectqs/index.rst: fix a replacement typo Antonin Godard
2026-08-11 10:00 ` [docs] " Robert P. J. Day
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20260811-bitbake-setup-pip-v1-1-0c8b350017e4@bootlin.com \
--to=antonin.godard@bootlin.com \
--cc=docs@lists.yoctoproject.org \
--cc=thomas.petazzoni@bootlin.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.