[PATCH 1/2] brief-yoctoprojectqs/index.rst: use pip to install bitbake-setup
Antonin Godard <[email protected]>
| Newsgroups | org.yoctoproject.lists.docs |
|---|---|
| Message-ID | <[email protected]> |
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 <[email protected]> --- 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