diff mbox series

dev-manual: Add info on build env initialization

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

Commit Message

Jasper Orschulko June 6, 2024, 1:50 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

Quentin Schulz June 6, 2024, 2:36 p.m. UTC | #1
Hi Jasper,

On 6/6/24 3:50 PM, Jasper Orschulko via lists.yoctoproject.org wrote:
> [You don't often get email from jasper=fancydomain.eu@lists.yoctoproject.org. Learn why this is important at https://aka.ms/LearnAboutSenderIdentification ]
> 
> 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..cfc1be65e 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
> +----------------------------------
> +

I don't think this should be at this level of (sub)section.

Indeed we would have:

Setting up to use the yocto project
->Cloning and Checking Out Branches
-->Initializing the Build Environment

I think it rather should be:

Setting up to use the yocto project
->Cloning and Checking Out Branches
->Initializing the Build Environment

So use = underlines instead of -.

> +Before you can use Yocto you need to setup the build environment.
> +From within the poky directory, source the oe-init-build-env environment

Please tick quote poky as it isn't a English word. c.f. 
https://git.yoctoproject.org/yocto-docs/tree/documentation/standards.md#n79

Additionally, please add a ref for oe-init-build-env, the same way we 
did for the Quick Build page:

:ref:`ref-manual/structure:\`\`oe-init-build-env\`\``

Otherwise looks ok, wondering if we shouldn't link from quick build->use 
git to clone poky+the first bullet point of Building Your image to the 
sections in dev-manual->start. But nothing required for this patch,

> +setup script to define Yocto Project’s build environment on your build host::
> +

Can you use a single quote here please: ' instead of the one in the 
sentence above? This will facilitate grepping if we ever need to :)

Thanks!
Quentin
diff mbox series

Patch

diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst
index 386e5f5d2..cfc1be65e 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 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.