From patchwork Thu Jun 6 15:04:10 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jasper Orschulko X-Patchwork-Id: 44772 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 51016C25B75 for ; Thu, 6 Jun 2024 15:04:23 +0000 (UTC) Received: from mx.walter.deinstapel.de (mx.walter.deinstapel.de [62.176.232.99]) by mx.groups.io with SMTP id smtpd.web10.16908.1717686260448307654 for ; Thu, 06 Jun 2024 08:04:21 -0700 Authentication-Results: mx.groups.io; dkim=fail reason="dkim: body hash did not verify" header.i=@fancydomain.eu header.s=mail header.b=NXkitk5B; spf=pass (domain: fancydomain.eu, ip: 62.176.232.99, mailfrom: jasper@fancydomain.eu) From: jasper@fancydomain.eu DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=fancydomain.eu; s=mail; t=1717686257; bh=AyFm/GSnKYVdfDFHmtP7s8hCJNCCOhJaN84m0eXR2f0=; h=From:To:Cc:Subject; b=NXkitk5BuV4LSVOja2YyvQgNdPbZESX8AyWk77bJESA/5cGcz8nB0l8l6DvhDahXg F2kxddrp2jl1ANueD0mCxPlp91DAtIXO4kiN6S1fJ6eUg7ghKj4+ShLS58hoR9uHV8 yBlepMRDU7kvfM8ViOWrE4aiOJNDqYu1oOd4f/MSqvRu2NFfr0d/bjQZgnB/qvvOcl /IUN/DkO8X8K9hkS3HG8+vJV1GMfu6GT3+U0i76a4HYZnuSX7ALOR1BTOT8v8V6a+6 ocrC5eoXZTKIuKxBEU5O8j0cn3B/cnHQVoJ+L2pkJfuNL1EqGZhpivi0wT92bV7dJS 8hGaSYX0nDw7w== To: docs@lists.yoctoproject.org Cc: aoife.power@iris-sensing.com, quentin.schulz@cherry.de, Jasper Orschulko Subject: [PATCH v2] dev-manual: Add info on build env initialization Date: Thu, 6 Jun 2024 17:04:10 +0200 Message-ID: <20240606150410.69388-1-jasper@fancydomain.eu> Mime-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Thu, 06 Jun 2024 15:04:23 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/5278 From: Jasper Orschulko 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 Reviewed-by: Quentin Schulz --- 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..66e70cf21 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.