diff mbox series

[v3] dev-manual: Add info on build env initialization

Message ID 20240606223427.3884-1-jasper@fancydomain.eu
State New
Headers show
Series [v3] dev-manual: Add info on build env initialization | expand

Commit Message

Jasper Orschulko June 6, 2024, 10:34 p.m. UTC
From: Jasper Orschulko <jasper@fancydomain.eu>

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.

Signed-off-by: Jasper Orschulko <jasper@fancydomain.eu>
---
 documentation/dev-manual/start.rst | 11 +++++++++++
 1 file changed, 11 insertions(+)

Comments

Michael Opdenacker June 7, 2024, 2:42 p.m. UTC | #1
Hi Jasper

On 6/7/24 00:34, jasper@fancydomain.eu wrote:
> From: Jasper Orschulko <jasper@fancydomain.eu>
>
> 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.
>
> Signed-off-by: Jasper Orschulko <jasper@fancydomain.eu>
> ---
>   documentation/dev-manual/start.rst | 11 +++++++++++
>   1 file changed, 11 insertions(+)
>
> diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst
> index 386e5f5d2..05827610b 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.
>      ``checkout`` command are a snapshot of the "&DISTRO_NAME_NO_CAP;"
>      development branch at the point where Yocto Project &DISTRO; was
>      released.
> +
> +Initializing the Build Environment
> +==================================
> +
> +Before you can use Yocto you need to setup the build environment.
> +From within the ``poky`` directory, source the :ref:`ref-manual/structure:\`\`oe-init-build-env\`\`` environment
> +setup script to define Yocto Project's build environment on your build host::
> +
> +    $ source oe-init-build-env
> +
> +Note, that this step will have to be repeated every time you open a new shell.

Thank you for the update! It looks good to me.
Reviewed-by: Michael Opdenacker <michael@opdenacker.org>
Cheers
Michael.
diff mbox series

Patch

diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst
index 386e5f5d2..05827610b 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.
    ``checkout`` command are a snapshot of the "&DISTRO_NAME_NO_CAP;"
    development branch at the point where Yocto Project &DISTRO; was
    released.
+
+Initializing the Build Environment
+==================================
+
+Before you can use Yocto you need to setup the build environment.
+From within the ``poky`` directory, source the :ref:`ref-manual/structure:\`\`oe-init-build-env\`\`` environment
+setup script to define Yocto Project's build environment on your build host::
+    
+    $ source oe-init-build-env 
+
+Note, that this step will have to be repeated every time you open a new shell.