From patchwork Fri Jan 12 16:53:06 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 37688 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 EA846C4706C for ; Fri, 12 Jan 2024 16:53:34 +0000 (UTC) Received: from relay1-d.mail.gandi.net (relay1-d.mail.gandi.net [217.70.183.193]) by mx.groups.io with SMTP id smtpd.web10.12594.1705078410365373873 for ; Fri, 12 Jan 2024 08:53:30 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=SU5e7+p1; spf=pass (domain: bootlin.com, ip: 217.70.183.193, mailfrom: michael.opdenacker@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 901D2240002; Fri, 12 Jan 2024 16:53:28 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1705078408; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=NcvQfYuD8ymoMEEWWcw0l7YC9ul4BmTZySA+btenn/U=; b=SU5e7+p19yl3N5jjV8qqHorg+7TCozzABZl1Ywfted8KCZpxE0LrOkjzv/BccvmEW1vLgO CKoWsKeVc3MkYQRVt20p25PiJd3I460YSRu2uNMoXsiAopj/hRP5OPCyNsYnv76MZC42FR 9khuvS7rEuWjFiREbVs0XUEHQ5ZpvRI6Rzkt+78k/VRrlxPzCH9L4LXSA871Odq9LDCXCy 1e6o/xSzPjBUiswc0Km1yxK+entvpz8NO8FgjJqhVb+jeDady93HyJ+UQLneID7yegvk4l cdLqP2jbbVGRBoz89RMWN2KHmCiX16oyRoffqwGcmi77PuTZ3NHjnwrWK0SMcg== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker Subject: [kirkstone][PATCH 1/6] contributor-guide: use "apt" instead of "aptitude" Date: Fri, 12 Jan 2024 17:53:06 +0100 Message-Id: <20240112165311.3554201-2-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240112165311.3554201-1-michael.opdenacker@bootlin.com> References: <20240112165311.3554201-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 X-GND-Sasl: michael.opdenacker@bootlin.com 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 ; Fri, 12 Jan 2024 16:53:34 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/4774 From: Michael Opdenacker As used in the rest of the manual. Signed-off-by: Michael Opdenacker --- documentation/contributor-guide/submit-changes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst index 289ec1383c..86f73c1dd0 100644 --- a/documentation/contributor-guide/submit-changes.rst +++ b/documentation/contributor-guide/submit-changes.rst @@ -57,7 +57,7 @@ Set up Git The first thing to do is to install Git packages. Here is an example on Debian and Ubuntu:: - sudo aptitude install git-core git-email + sudo apt install git-core git-email Then, you need to set a name and e-mail address that Git will use to identify your commits:: From patchwork Fri Jan 12 16:53:07 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 37693 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 F2008C47258 for ; Fri, 12 Jan 2024 16:53:44 +0000 (UTC) Received: from relay7-d.mail.gandi.net (relay7-d.mail.gandi.net [217.70.183.200]) by mx.groups.io with SMTP id smtpd.web11.12410.1705078418420447337 for ; Fri, 12 Jan 2024 08:53:38 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=S8ZMa5pq; spf=pass (domain: bootlin.com, ip: 217.70.183.200, mailfrom: michael.opdenacker@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 02C452000A; Fri, 12 Jan 2024 16:53:36 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1705078417; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=xKSZe3PkMiVNNoBrz/Bp0EntPTUGCLTBxTuc9shQN1c=; b=S8ZMa5pqOehkGxFYmLu/m/EQx+SoVS+sHf/SLHAEXNMF6StHnEq2IZNuYN2YLU34VbNzo8 VFPUrs/xtQTZg0asjI/mL/3CX8PeBmoek9Nbg+ACpqbXQjM5YStqJMZF5In4PAgfl3gPaY +E1c6/6ns8hA2RRfT2YGEd1EXvVIV33lE2KMJyldquVDe6BahjEK+QStwQv1HGD14ABMCT Gt2x/5G39asY/P+a5bZbQsgsnwtrIH1OLt6wn1U40170RdqyaSL3pPm0e5dV0E9uPErUJ+ M/Ns4rrUhBGAlEqg0JR2C0TKLFO77JXDbXMb2V/XyHv8FX4z/PRvf+NyljRlvw== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , =?utf-8?q?Simone_We?= =?utf-8?q?i=C3=9F?= Subject: [kirkstone][PATCH 2/6] dev-manual: start.rst: update use of Download page Date: Fri, 12 Jan 2024 17:53:07 +0100 Message-Id: <20240112165311.3554201-3-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240112165311.3554201-1-michael.opdenacker@bootlin.com> References: <20240112165311.3554201-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 X-GND-Sasl: michael.opdenacker@bootlin.com 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 ; Fri, 12 Jan 2024 16:53:44 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/4775 From: Michael Opdenacker From: Simone Weiß The yocto website has changed its structure. Update the section for Accessing the Downloads page to match the new structure. Signed-off-by: Simone Weiß Reviewed-by: Michael Opdenacker --- documentation/dev-manual/start.rst | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst index 3bc4244595..5a81506a9b 100644 --- a/documentation/dev-manual/start.rst +++ b/documentation/dev-manual/start.rst @@ -642,7 +642,7 @@ Follow these steps to locate and download a particular tarball: Using the Downloads Page ------------------------ -The :yocto_home:`Yocto Project Website <>` uses a "DOWNLOADS" page +The :yocto_home:`Yocto Project Website <>` uses a "RELEASES" page from which you can locate and download tarballs of any Yocto Project release. Rather than Git repositories, these files represent snapshot tarballs similar to the tarballs located in the Index of Releases @@ -651,11 +651,13 @@ described in the ":ref:`dev-manual/start:accessing index of releases`" section. 1. *Go to the Yocto Project Website:* Open The :yocto_home:`Yocto Project Website <>` in your browser. -2. *Get to the Downloads Area:* Select the "DOWNLOADS" item from the - pull-down "SOFTWARE" tab menu near the top of the page. +#. *Get to the Downloads Area:* Select the "RELEASES" item from the + pull-down "DEVELOPMENT" tab menu near the top of the page. -3. *Select a Yocto Project Release:* Use the menu next to "RELEASE" to - display and choose a recent or past supported Yocto Project release +#. *Select a Yocto Project Release:* On the top of the "RELEASE" page currently + supported releases are displayed, further down past supported Yocto Project + releases are visible. The "Download" links in the rows of the table there + will lead to the download tarballs for the release (e.g. &DISTRO_NAME_NO_CAP;, &DISTRO_NAME_NO_CAP_MINUS_ONE;, and so forth). .. note:: @@ -666,9 +668,9 @@ described in the ":ref:`dev-manual/start:accessing index of releases`" section. You can use the "RELEASE ARCHIVE" link to reveal a menu of all Yocto Project releases. -4. *Download Tools or Board Support Packages (BSPs):* From the - "DOWNLOADS" page, you can download tools or BSPs as well. Just scroll - down the page and look for what you need. +#. *Download Tools or Board Support Packages (BSPs):* Next to the tarballs you + will find download tools or BSPs as well. Just select a Yocto Project + release and look for what you need. Cloning and Checking Out Branches ================================= From patchwork Fri Jan 12 16:53:08 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 37691 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 03141C4706C for ; Fri, 12 Jan 2024 16:53:45 +0000 (UTC) Received: from relay1-d.mail.gandi.net (relay1-d.mail.gandi.net [217.70.183.193]) by mx.groups.io with SMTP id smtpd.web11.12411.1705078418871659818 for ; Fri, 12 Jan 2024 08:53:39 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=dja25iRY; spf=pass (domain: bootlin.com, ip: 217.70.183.193, mailfrom: michael.opdenacker@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 5DE2C240006; Fri, 12 Jan 2024 16:53:37 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1705078417; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=uo6j4L+/Wg1LOnF0K7ujcic56OGsMQnyAQacxKYADLI=; b=dja25iRYf6nGQm91TcaQCzSf0rSFXtJ0m/Au8Uc4goy1WCN3Z3HlOpXqKJCGNiYUck2LJc SJy0wyM0PCZbdmjNbqLo4shlU66lypNWq4gVwz0q9TPUbr0phf+/gMM3487dvoMKW2YW4E QYq/CSlX3eGeHF7JEKrYts8dFjAkbS8K2yNGh1IF6l1ksxtlnLySLMGstxn8/IVZYR1H+Y Gts6iCPrcTj/QwpFImpa4tD9DpqFhARlL29HaGlqInYpA3VF/3qqUPXwB9I/YlM7ukENrV jaaGzfak3R3TJtqnlIocHQkzPuRwf5mlhJvoYuVNyiIOWVCmHFrUO0vuZqGbfA== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Maxin John Subject: [kirkstone][PATCH 3/6] ref-manual: classes: remove insserv bbclass Date: Fri, 12 Jan 2024 17:53:08 +0100 Message-Id: <20240112165311.3554201-4-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240112165311.3554201-1-michael.opdenacker@bootlin.com> References: <20240112165311.3554201-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 X-GND-Sasl: michael.opdenacker@bootlin.com 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 ; Fri, 12 Jan 2024 16:53:45 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/4776 From: Michael Opdenacker From: Maxin B. John insserv.bbclass was removed from oe-core: commit e6bb5dbb62257a7de730ea9085dfd89520f3e47d Author: Richard Purdie Date: Sun May 10 12:30:49 2015 +0100 insserv: Remove Signed-off-by: Maxin John Reviewed-by: Michael Opdenacker --- documentation/ref-manual/classes.rst | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 6074ea0f52..0677157b3b 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst @@ -1462,16 +1462,6 @@ Here are the tests you can list with the :term:`WARN_QA` and automatically get these versions. Consequently, you should only need to explicitly add dependencies to binary driver recipes. -.. _ref-classes-insserv: - -``insserv`` -=========== - -The :ref:`ref-classes-insserv` class uses the ``insserv`` utility to update the order -of symbolic links in ``/etc/rc?.d/`` within an image based on -dependencies specified by LSB headers in the ``init.d`` scripts -themselves. - .. _ref-classes-kernel: ``kernel`` From patchwork Fri Jan 12 16:53:09 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 37689 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 12A9FC47DA2 for ; Fri, 12 Jan 2024 16:53:45 +0000 (UTC) Received: from relay7-d.mail.gandi.net (relay7-d.mail.gandi.net [217.70.183.200]) by mx.groups.io with SMTP id smtpd.web10.12601.1705078419102044145 for ; Fri, 12 Jan 2024 08:53:39 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=PxM9Z1Sa; spf=pass (domain: bootlin.com, ip: 217.70.183.200, mailfrom: michael.opdenacker@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id B1CF32000C; Fri, 12 Jan 2024 16:53:37 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1705078417; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=x3GtAzUUJKz3scuNs7LYTL8+/APIo6Uc+zrm5SSer8g=; b=PxM9Z1SaBDUszls6efzhSZ5u9zr+BpvvbykQ8YiN2akv+1bWcPm189Pg67UYfkTtWiiIJH XmXS60yaRRaSzih7hSfnkABzs7IPp6yWbUkcd1S01mkYEZGPuVYGqkmqffqIUENlXcBaos 27kiG/AsvyhmFpoSxtpmYHsrN67iAtSe1sbmWtfXlFuM8Lvf32GLrW48/9bJH4yKXZA5nP obnbG9fG1eekuVRS6cu8VurjpPorLRDSnFcmTDCzdy0bsl4VJMzixnVIfOqa0iYB7Axj7l HGZFoUzIcPl18FRQfY8/h1V+GTjcG0C5P8rMqoBfn5byPhKNsJkaJxQ8nshGbQ== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker Subject: [kirkstone][PATCH 4/6] ref-manual: resources: sync with master branch Date: Fri, 12 Jan 2024 17:53:09 +0100 Message-Id: <20240112165311.3554201-5-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240112165311.3554201-1-michael.opdenacker@bootlin.com> References: <20240112165311.3554201-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 X-GND-Sasl: michael.opdenacker@bootlin.com 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 ; Fri, 12 Jan 2024 16:53:45 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/4777 From: Michael Opdenacker Signed-off-by: Michael Opdenacker --- documentation/ref-manual/resources.rst | 66 +++++++++++++------------- 1 file changed, 33 insertions(+), 33 deletions(-) diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst index a175a1db8e..8c3726e83b 100644 --- a/documentation/ref-manual/resources.rst +++ b/documentation/ref-manual/resources.rst @@ -63,26 +63,28 @@ and announcements. To subscribe to one of the following mailing lists, click on the appropriate URL in the following list and follow the instructions: -- :yocto_lists:`/g/yocto` - General Yocto Project +- :yocto_lists:`/g/yocto` --- general Yocto Project discussion mailing list. -- :oe_lists:`/g/openembedded-core` - Discussion mailing +- :oe_lists:`/g/openembedded-core` --- discussion mailing list about OpenEmbedded-Core (the core metadata). -- :oe_lists:`/g/openembedded-devel` - Discussion +- :oe_lists:`/g/openembedded-devel` --- discussion mailing list about OpenEmbedded. -- :oe_lists:`/g/bitbake-devel` - Discussion mailing +- :oe_lists:`/g/bitbake-devel` --- discussion mailing list about the :term:`BitBake` build tool. -- :yocto_lists:`/g/poky` - Discussion mailing list +- :yocto_lists:`/g/poky` --- discussion mailing list about :term:`Poky`. -- :yocto_lists:`/g/yocto-announce` - Mailing list to +- :yocto_lists:`/g/yocto-announce` --- mailing list to receive official Yocto Project release and milestone announcements. -For more Yocto Project-related mailing lists, see the -:yocto_home:`Yocto Project Website <>`. +- :yocto_lists:`/g/docs` --- discussion mailing list about the Yocto Project + documentation. + +See also :yocto_home:`the description of all mailing lists `. .. _resources-irc: @@ -103,93 +105,91 @@ Links and Related Documentation Here is a list of resources you might find helpful: -- :yocto_home:`The Yocto Project Website <>`\ *:* The home site +- :yocto_home:`The Yocto Project Website <>`: The home site for the Yocto Project. -- :yocto_wiki:`The Yocto Project Main Wiki Page <>`\ *:* The main wiki page for +- :yocto_wiki:`The Yocto Project Main Wiki Page <>`: The main wiki page for the Yocto Project. This page contains information about project planning, release engineering, QA & automation, a reference site map, and other resources related to the Yocto Project. -- :oe_home:`OpenEmbedded <>`\ *:* The build system used by the +- :oe_home:`OpenEmbedded <>`: The build system used by the Yocto Project. This project is the upstream, generic, embedded distribution from which the Yocto Project derives its build system (Poky) and to which it contributes. -- :oe_wiki:`BitBake `\ *:* The tool used to process metadata. +- :oe_wiki:`BitBake `: The tool used to process metadata. -- :doc:`BitBake User Manual `\ *:* A comprehensive +- :doc:`BitBake User Manual `: A comprehensive guide to the BitBake tool. If you want information on BitBake, see this manual. -- :doc:`/brief-yoctoprojectqs/index` *:* This +- :doc:`/brief-yoctoprojectqs/index`: This short document lets you experience building an image using the Yocto Project without having to understand any concepts or details. -- :doc:`/overview-manual/index` *:* This manual provides overview +- :doc:`/overview-manual/index`: This manual provides overview and conceptual information about the Yocto Project. -- :doc:`/dev-manual/index` *:* This manual is a "how-to" guide +- :doc:`/dev-manual/index`: This manual is a "how-to" guide that presents procedures useful to both application and system developers who use the Yocto Project. -- :doc:`/sdk-manual/index` *manual :* This +- :doc:`/sdk-manual/index` manual: This guide provides information that lets you get going with the standard or extensible SDK. An SDK, with its cross-development toolchains, allows you to develop projects inside or outside of the Yocto Project environment. -- :doc:`/bsp-guide/bsp` *:* This guide defines the structure +- :doc:`/bsp-guide/bsp`: This guide defines the structure for BSP components. Having a commonly understood structure encourages standardization. -- :doc:`/kernel-dev/index` *:* This manual describes +- :doc:`/kernel-dev/index`: This manual describes how to work with Linux Yocto kernels as well as provides a bit of conceptual information on the construction of the Yocto Linux kernel tree. -- :doc:`/ref-manual/index` *:* This +- :doc:`/ref-manual/index`: This manual provides reference material such as variable, task, and class descriptions. -- :yocto_docs:`Yocto Project Mega-Manual `\ *:* This manual +- :yocto_docs:`Yocto Project Mega-Manual `: This manual is simply a single HTML file comprised of the bulk of the Yocto Project manuals. It makes it easy to search for phrases and terms used in the Yocto Project documentation set. -- :doc:`/profile-manual/index` *:* This manual presents a set of +- :doc:`/profile-manual/index`: This manual presents a set of common and generally useful tracing and profiling schemes along with their applications (as appropriate) to each tool. -- :doc:`/toaster-manual/index` *:* This manual +- :doc:`/toaster-manual/index`: This manual introduces and describes how to set up and use Toaster. Toaster is an Application Programming Interface (API) and web-based interface to the :term:`OpenEmbedded Build System`, which uses BitBake, that reports build information. -- :yocto_wiki:`FAQ `\ *:* A list of commonly asked +- :yocto_wiki:`FAQ `: A list of commonly asked questions and their answers. -- *Release Notes:* Features, updates and known issues for the current - release of the Yocto Project. To access the Release Notes, go to the - :yocto_home:`Downloads ` page on - the Yocto Project website and click on the "RELEASE INFORMATION" link - for the appropriate release. +- :doc:`Release Information `: + Migration guides, release notes, new features, updates and known issues + for the current and past releases of the Yocto Project. -- :yocto_bugs:`Bugzilla <>`\ *:* The bug tracking application +- :yocto_bugs:`Bugzilla <>`: The bug tracking application the Yocto Project uses. If you find problems with the Yocto Project, you should report them using this application. - :yocto_wiki:`Bugzilla Configuration and Bug Tracking Wiki Page - `\ *:* + `: Information on how to get set up and use the Yocto Project implementation of Bugzilla for logging and tracking Yocto Project defects. -- *Internet Relay Chat (IRC):* Two IRC channels on +- Internet Relay Chat (IRC): Two IRC channels on `Libera Chat `__ are available for Yocto Project and OpenEmbeddded discussions: ``#yocto`` and ``#oe``, respectively. -- `Quick EMUlator (QEMU) `__\ *:* An +- `Quick EMUlator (QEMU) `__: An open-source machine emulator and virtualizer. From patchwork Fri Jan 12 16:53:10 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 37692 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 199CEC47DA6 for ; Fri, 12 Jan 2024 16:53:45 +0000 (UTC) Received: from relay1-d.mail.gandi.net (relay1-d.mail.gandi.net [217.70.183.193]) by mx.groups.io with SMTP id smtpd.web11.12412.1705078419525136611 for ; Fri, 12 Jan 2024 08:53:39 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=VzrinYNk; spf=pass (domain: bootlin.com, ip: 217.70.183.193, mailfrom: michael.opdenacker@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 11E3A240002; Fri, 12 Jan 2024 16:53:38 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1705078418; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=r63Xkwzy0/VSVomXLU/Q4TJ7tLWTc+IYfGcXRNHc3Mo=; b=VzrinYNkJLhYoOceiJkfslp0o7il+QDFrTgZqaRMDaWs8l2MBc4Y/voqt0TMErQ/Ajhnpn hJ7OHx6dytV/KKlqW3wcrS7GpOqxMMJfZVXBIcU1m7ll2WzW9YMZgAHsm1QnsZN2rpbIiB 3BU/4uY3wk7qcuTHFna5Qbkh3ebsYpTSf4KLw61OqYE4BLO7Qruqw/stqR49hmBsl9Rii6 iS1cR2Cz9TQGhnpvCTCJDr50A1FpCxbG3Xz73GbJ//4peGKTwmdbYcwJxZHHwAvxTG4p3l AKSW2PAMfyiB5w+PN980Rc4tQYbGckA9fjB6IkTDwj/CrP8ZsUpx8Mi3ecwcQQ== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Enguerrand de Ribaucourt Subject: [kirkstone][PATCH 5/6] manuals: document VSCode extension Date: Fri, 12 Jan 2024 17:53:10 +0100 Message-Id: <20240112165311.3554201-6-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240112165311.3554201-1-michael.opdenacker@bootlin.com> References: <20240112165311.3554201-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 X-GND-Sasl: michael.opdenacker@bootlin.com 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 ; Fri, 12 Jan 2024 16:53:45 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/4778 From: Michael Opdenacker From: Enguerrand de Ribaucourt The VSCode extension is now officially maintained and published by the Yocto Project so it should be referenced in the manuals to help users discover it. I located the most relevant places to reference the extension by looking at how the old Eclipse plugin was documented in the 2.6 manuals as well as the current Toaster references. Signed-off-by: Enguerrand de Ribaucourt Reviewed-by: Michael Opdenacker --- documentation/dev-manual/building.rst | 4 ++++ documentation/dev-manual/start.rst | 15 +++++++++++--- .../development-environment.rst | 8 ++++++++ documentation/overview-manual/yp-intro.rst | 20 +++++++++++++++++++ documentation/ref-manual/resources.rst | 5 +++++ documentation/what-i-wish-id-known.rst | 7 +++++++ 6 files changed, 56 insertions(+), 3 deletions(-) diff --git a/documentation/dev-manual/building.rst b/documentation/dev-manual/building.rst index a395793493..e964bd1aee 100644 --- a/documentation/dev-manual/building.rst +++ b/documentation/dev-manual/building.rst @@ -32,6 +32,10 @@ build host running Linux. OpenEmbedded build system, see the :doc:`/brief-yoctoprojectqs/index` document. + - You can also use the `Yocto Project BitBake + `__ + extension for Visual Studio Code to build images. + The build process creates an entire Linux distribution from source and places it in your :term:`Build Directory` under ``tmp/deploy/images``. For detailed information on the build process using BitBake, see the diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst index 5a81506a9b..44503a5183 100644 --- a/documentation/dev-manual/start.rst +++ b/documentation/dev-manual/start.rst @@ -332,7 +332,10 @@ to use the Extensible SDK, see the ":doc:`/sdk-manual/extensible`" Chapter in th Project Application Development and the Extensible Software Development Kit (eSDK) manual. If you want to work on the kernel, see the :doc:`/kernel-dev/index`. If you are going to use Toaster, see the ":doc:`/toaster-manual/setup-and-use`" -section in the Toaster User Manual. +section in the Toaster User Manual. If you are a VSCode user, you can configure +the `Yocto Project BitBake +`__ +extension accordingly. Setting Up to Use CROss PlatformS (CROPS) ----------------------------------------- @@ -424,7 +427,10 @@ section. If you are going to use the Extensible SDK container, see the Project Application Development and the Extensible Software Development Kit (eSDK) manual. If you are going to use the Toaster container, see the ":doc:`/toaster-manual/setup-and-use`" -section in the Toaster User Manual. +section in the Toaster User Manual. If you are a VSCode user, you can configure +the `Yocto Project BitBake +`__ +extension accordingly. Setting Up to Use Windows Subsystem For Linux (WSLv2) ----------------------------------------------------- @@ -554,7 +560,10 @@ Extensible SDK container, see the ":doc:`/sdk-manual/extensible`" Chapter in the Project Application Development and the Extensible Software Development Kit (eSDK) manual. If you are going to use the Toaster container, see the ":doc:`/toaster-manual/setup-and-use`" -section in the Toaster User Manual. +section in the Toaster User Manual. If you are a VSCode user, you can configure +the `Yocto Project BitBake +`__ +extension accordingly. Locating Yocto Project Source Files =================================== diff --git a/documentation/overview-manual/development-environment.rst b/documentation/overview-manual/development-environment.rst index 332cea836d..30c7af4531 100644 --- a/documentation/overview-manual/development-environment.rst +++ b/documentation/overview-manual/development-environment.rst @@ -132,6 +132,14 @@ are several ways of working in the Yocto Project environment: Toaster and on how to use Toaster in general, see the :doc:`/toaster-manual/index`. +- *Using the VSCode Extension:* You can use the `Yocto Project BitBake + `__ + extension for Visual Studio Code to start your BitBake builds through a + graphical user interface. + + Learn more about the VSCode Extension on the `extension's marketplace page + `__. + Yocto Project Source Repositories ================================= diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst index 25dc08b09d..f7cd2486af 100644 --- a/documentation/overview-manual/yp-intro.rst +++ b/documentation/overview-manual/yp-intro.rst @@ -340,6 +340,18 @@ the Yocto Project: view information about builds. For information on Toaster, see the :doc:`/toaster-manual/index`. +- *VSCode IDE Extension:* The `Yocto Project BitBake + `__ + extension for Visual Studio Code provides a rich set of features for working + with BitBake recipes. The extension provides syntax highlighting, + hover tips, and completion for BitBake files as well as embedded Python and + Bash languages. Additional views and commands allow you to efficiently + browse, build and edit recipes. It also provides SDK integration for + cross-compiling and debugging through ``devtool``. + + Learn more about the VSCode Extension on the `extension's frontpage + `__. + Production Tools ---------------- @@ -610,6 +622,14 @@ Build Host runs, you have several choices. For information about and how to use Toaster, see the :doc:`/toaster-manual/index`. +- *Using the VSCode Extension:* You can use the `Yocto Project BitBake + `__ + extension for Visual Studio Code to start your BitBake builds through a + graphical user interface. + + Learn more about the VSCode Extension on the `extension's marketplace page + `__ + Reference Embedded Distribution (Poky) ====================================== diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst index 8c3726e83b..8e54ac87c9 100644 --- a/documentation/ref-manual/resources.rst +++ b/documentation/ref-manual/resources.rst @@ -169,6 +169,11 @@ Here is a list of resources you might find helpful: the :term:`OpenEmbedded Build System`, which uses BitBake, that reports build information. +- `Yocto Project BitBake extension for VSCode + `__: + This extension provides a rich feature set when working with BitBake recipes + within the Visual Studio Code IDE. + - :yocto_wiki:`FAQ `: A list of commonly asked questions and their answers. diff --git a/documentation/what-i-wish-id-known.rst b/documentation/what-i-wish-id-known.rst index 4843f02276..c21810d49b 100644 --- a/documentation/what-i-wish-id-known.rst +++ b/documentation/what-i-wish-id-known.rst @@ -213,6 +213,13 @@ contact us with other suggestions. OpenEmbedded build system. If you are interested in using this type of interface to create images, see the :doc:`/toaster-manual/index`. + * **Discover the VSCode extension**: The `Yocto Project BitBake + `__ + extension for the Visual Studio Code IDE provides language features and + commands for working with the Yocto Project. If you are interested in using + this extension, visit its `marketplace page + `__. + * **Have Available the Yocto Project Reference Manual**: Unlike the rest of the Yocto Project manual set, this manual is comprised of material suited for reference rather than procedures. You can get build details, a closer From patchwork Fri Jan 12 16:53:11 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 37690 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 F2308C4725D for ; Fri, 12 Jan 2024 16:53:44 +0000 (UTC) Received: from relay9-d.mail.gandi.net (relay9-d.mail.gandi.net [217.70.183.199]) by mx.groups.io with SMTP id smtpd.web11.12413.1705078419942985478 for ; Fri, 12 Jan 2024 08:53:40 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=Re9Q8xti; spf=pass (domain: bootlin.com, ip: 217.70.183.199, mailfrom: michael.opdenacker@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 7FDECFF805; Fri, 12 Jan 2024 16:53:38 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1705078418; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=2njVLYMTXhS1daEWrF2s0nK68VIV2tKUlwozvNQAVIE=; b=Re9Q8xtiikiztKJRiSPSqGycM56dY5CAwIVE98J+Hd4KZgqwEG45KsXOa5PUYkTKdzfpx0 a45jhWFQqrh4yQjEpNHmKna52p47ib1L2mWVDAQ6bFGHGaZeSp3xXipRZbZKvdZcxSX1Hw eeg/LReyckRDsytop1jcJND2l9QF0qJUgWHkOUwDwsDkC8oCq2Uts+VJWGjtjZGzgHQeaQ JBdzV7jceLJB72b3fcHYvxoq5kB15MGOhbtmFgfP8HeFOJL9MYuw7TIF/KDp2/lddltM7/ 8W4p1VilI15Fp39BLzt3vLfTNaNWu2x/05jlOe1Ld4j/DIa46TB1dWRt4BdyLA== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , =?utf-8?q?J=C3=B6rg?= =?utf-8?q?_Sommer?= Subject: [kirkstone][PATCH 6/6] documentation: Add UBOOT_BINARY, extend UBOOT_CONFIG Date: Fri, 12 Jan 2024 17:53:11 +0100 Message-Id: <20240112165311.3554201-7-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240112165311.3554201-1-michael.opdenacker@bootlin.com> References: <20240112165311.3554201-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 X-GND-Sasl: michael.opdenacker@bootlin.com 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 ; Fri, 12 Jan 2024 16:53:44 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/4779 From: Michael Opdenacker From: Jörg Sommer UBOOT_CONFIG accepts a third parameter for the UBOOT_BINARY that isn't documented. To show its usage another example from the meta-freescale layer was picked. Signed-off-by: Jörg Sommer Reviewed-by: Michael Opdenacker --- documentation/ref-manual/classes.rst | 2 +- documentation/ref-manual/variables.rst | 39 +++++++++++++++----------- 2 files changed, 24 insertions(+), 17 deletions(-) diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 0677157b3b..216b236e33 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst @@ -3131,7 +3131,7 @@ The :ref:`ref-classes-uboot-config` class provides support for U-Boot configurat a machine. Specify the machine in your recipe as follows:: UBOOT_CONFIG ??= - UBOOT_CONFIG[foo] = "config,images" + UBOOT_CONFIG[foo] = "config,images,binary" You can also specify the machine using this method:: diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index fe0b993bd8..ae14c450dd 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -8932,23 +8932,30 @@ system and gives an overview of their function and contents. See the machine include files in the :term:`Source Directory` for these features. + :term:`UBOOT_BINARY` + Specifies the name of the binary build by U-Boot. + :term:`UBOOT_CONFIG` - Configures the :term:`UBOOT_MACHINE` and can - also define :term:`IMAGE_FSTYPES` for individual - cases. - - Following is an example from the ``meta-fsl-arm`` layer. :: - - UBOOT_CONFIG ??= "sd" - UBOOT_CONFIG[sd] = "mx6qsabreauto_config,sdcard" - UBOOT_CONFIG[eimnor] = "mx6qsabreauto_eimnor_config" - UBOOT_CONFIG[nand] = "mx6qsabreauto_nand_config,ubifs" - UBOOT_CONFIG[spinor] = "mx6qsabreauto_spinor_config" - - In this example, "sd" is selected as the configuration of the possible four for the - :term:`UBOOT_MACHINE`. The "sd" configuration defines - "mx6qsabreauto_config" as the value for :term:`UBOOT_MACHINE`, while the - "sdcard" specifies the :term:`IMAGE_FSTYPES` to use for the U-Boot image. + Configures one or more U-Boot configurations to build. Each + configuration can define the :term:`UBOOT_MACHINE` and optionally the + :term:`IMAGE_FSTYPES` and the :term:`UBOOT_BINARY`. + + Following is an example from the ``meta-freescale`` layer. :: + + UBOOT_CONFIG ??= "sdcard-ifc-secure-boot sdcard-ifc sdcard-qspi lpuart qspi secure-boot nor" + UBOOT_CONFIG[nor] = "ls1021atwr_nor_defconfig" + UBOOT_CONFIG[sdcard-ifc] = "ls1021atwr_sdcard_ifc_defconfig,,u-boot-with-spl-pbl.bin" + UBOOT_CONFIG[sdcard-qspi] = "ls1021atwr_sdcard_qspi_defconfig,,u-boot-with-spl-pbl.bin" + UBOOT_CONFIG[lpuart] = "ls1021atwr_nor_lpuart_defconfig" + UBOOT_CONFIG[qspi] = "ls1021atwr_qspi_defconfig" + UBOOT_CONFIG[secure-boot] = "ls1021atwr_nor_SECURE_BOOT_defconfig" + UBOOT_CONFIG[sdcard-ifc-secure-boot] = "ls1021atwr_sdcard_ifc_SECURE_BOOT_defconfig,,u-boot-with-spl-pbl.bin" + + In this example, all possible seven configurations are selected. Each + configuration specifies "..._defconfig" as :term:`UBOOT_MACHINE`, and + the "sd..." configurations define an individual name for + :term:`UBOOT_BINARY`. No configuration defines a second parameter for + :term:`IMAGE_FSTYPES` to use for the U-Boot image. For more information on how the :term:`UBOOT_CONFIG` is handled, see the :ref:`uboot-config `