summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorJasper Orschulko <jasper@fancydomain.eu>2024-06-07 00:34:27 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2024-06-16 22:48:18 +0100
commit5d737bf584eafc56368b4a2052e9f501ab8fd6c9 (patch)
tree1ebc87a9b569c85ab0e4bbc51bf3b14a813f49f5 /documentation
parent0df9d22928cd5c5e0a6db7efb7a2480f29124bd5 (diff)
downloadpoky-5d737bf584eafc56368b4a2052e9f501ab8fd6c9.tar.gz
dev-manual: Add info on build env initialization
Going through the docs we a new trainee, we noticed that the build initialization is only mentioned in the quick build (https://docs.yoctoproject.org/brief-yoctoprojectqs/index.html) but not in the in-depth getting started documentation. While this is repeatedly mentioned later on, e.g. in the "building" section, you might easily end up somewhere where this has not been mentioned yet. E.g. in our case this was: https://docs.yoctoproject.org/dev-manual/layers.html# (which comes right after the "setup" chapter) -> https://docs.yoctoproject.org/dev-manual/layers.html#creating-a-general-layer-using-the-bitbake-layers-script (which is linked right at the top) To avoid any confusion I think it best to mention this required step directly in the "start" document. (From yocto-docs rev: d7a36b7b8e770ae45b991698d588f9522ba59b4e) Signed-off-by: Jasper Orschulko <jasper@fancydomain.eu> Reviewed-by: Michael Opdenacker <michael@opdenacker.org> Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/start.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst
index 386e5f5d29..05827610b7 100644
--- a/documentation/dev-manual/start.rst
+++ b/documentation/dev-manual/start.rst
@@ -853,3 +853,14 @@ similar to checking out by branch name except you use tag names.
853 ``checkout`` command are a snapshot of the "&DISTRO_NAME_NO_CAP;" 853 ``checkout`` command are a snapshot of the "&DISTRO_NAME_NO_CAP;"
854 development branch at the point where Yocto Project &DISTRO; was 854 development branch at the point where Yocto Project &DISTRO; was
855 released. 855 released.
856
857Initializing the Build Environment
858==================================
859
860Before you can use Yocto you need to setup the build environment.
861From within the ``poky`` directory, source the :ref:`ref-manual/structure:\`\`oe-init-build-env\`\`` environment
862setup script to define Yocto Project's build environment on your build host::
863
864 $ source oe-init-build-env
865
866Note, that this step will have to be repeated every time you open a new shell.