From patchwork Fri Jul 24 13:24:58 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 93448 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 37449C531C9 for ; Fri, 24 Jul 2026 13:25:14 +0000 (UTC) Received: from smtpout-02.galae.net (smtpout-02.galae.net [185.246.84.56]) by mx.groups.io with SMTP id smtpd.msgproc01-g2.19146.1784899511796033395 for ; Fri, 24 Jul 2026 06:25:13 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=Y25m51s/; spf=pass (domain: bootlin.com, ip: 185.246.84.56, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-02.galae.net (Postfix) with ESMTPS id 2EF091A11E7 for ; Fri, 24 Jul 2026 13:25:10 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id F1AD160395 for ; Fri, 24 Jul 2026 13:25:09 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id 04E9411C10FFB; Fri, 24 Jul 2026 15:25:08 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1784899509; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=lxOH1h4b+m9XnUlCYvQKCl17Uz5LwCPlrcyhH26zHP4=; b=Y25m51s/7BzW7K5FshJdwoAF4KBTNoTK/RuoVMjcgd4aubcW5I2utr9erLMb+CPo6A+SGI p5FuzD4dvL7mPv474Fw1I8XfKm1Y9gCv3/gmXVb8gEtqOW1itn4Si3bYgym54TLEJKghWA fElPvIMTPGsTy623HLEV1F1JhM1OtFWQIPwQ8XjwIVgnGnwHwODRqCE7sDyJGCOyDz+h5s k6m06kSCpGGnIS503/FTnO1EFtshGK4BRTRnVzyQbb0MrKTn4cIdYoUjqzfrMUm3Xiuxhs ow6eqwGMcbWKNi7owJuLy0QUMO4jOPIuH3lBdH3/urydh9/wqaxRr5cWCyaN2A== From: Antonin Godard Date: Fri, 24 Jul 2026 15:24:58 +0200 Subject: [PATCH 1/9] index.rst: add introduction paragraphs MIME-Version: 1.0 Message-Id: <20260724-rework-welcome-page-v1-1-491772cc4b65@bootlin.com> References: <20260724-rework-welcome-page-v1-0-491772cc4b65@bootlin.com> In-Reply-To: <20260724-rework-welcome-page-v1-0-491772cc4b65@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard X-Mailer: b4 0.15.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=3306; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=cLK1dUaWVs2ngdQX1fe4/41SEddRF31xoQhw9V6JIjw=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBqY2exTK/OHE1tTni9h28VUXW/6GkrnSyfvv1Sn MQQYdmrcfGJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCamNnsQAKCRDRgEFAKaOo NmYdD/9kBZKM+HYHToSX8bWgZlio7E46SCoVMeEyzYdDho3DVAukCOjw9BS3qFecUMkn0dmavCo EkUlVJKcKCKPQI9w29Vee4yqUL9bvYMu15TXnL3jcePIvl8DycD7DsOA4wEf6+95Cub2qVz5qlr 1LuFFlV0tXvsi8X1ntuNOSsyClWmBrWqp0fKntN70ETfMQLw1AdulxlkfTWv8n2a2PMnMPyLeQ1 nrCS12+pm2do4bv6w5mb4dt2xHogQREULk36PDp9xxkYrqmExSfMubl1g7pXOuG2s/I7/CUd6OC bPJuoKAfv7yhfsjgYpHka8NsHfKRpMv/wfVvMZRx94XNfvNYsl0fFPoLXZUVCXs1b+fshUHAm9n GFhSYjhwvd41o0qZq/eZAiZsF+jWNqH4bWHfTjdv62PCbA+GLoGBYRwuaeqtn6q0z25PXGIdL/a 2eIe846DBprSXA4BL1UwIMS4/gGmRxrw91BCVdz3Hv0lgXDwUPD4kf2Bjo+7/4AKVUnbBZxH7ZV ichzZAmIk117tnodFazddkckVNEg5UYBfXWiUaNeZyfWCKs5fC3YMXCPCUljHXiLPen6L5o/ifF KddAhkYiAHUzYrW/GmzlyVrpjYuOTagg1NE2IZ9kDHaa9K18jWkTFzAEHBaP76sICP8Uybe65b3 JUSwpoxgXnQOpXw== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-Last-TLS-Session-Version: TLSv1.3 List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 24 Jul 2026 13:25:14 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/10130 The homepage of the Yocto Project documentation currently has no introduction and only displays the table of contents. Inspired by https://docs.kernel.org, provide a short introduction to the documentation and also precede each section with a short sentence about what the section contains. The section titles are voluntarily duplicated in the document itself and in the toctree directive, so that the sidebar still contains them, and we can have text between the section titles and the toctree content. However this also duplicates the title in the document itself, so add CSS directive in our customization file to hide the duplicates. Note that these titles do not show in the PDF and ePub outputs as those are generated differently. Signed-off-by: Antonin Godard --- documentation/index.rst | 25 +++++++++++++++++++++++-- documentation/sphinx-static/theme_overrides.css | 4 ++++ 2 files changed, 27 insertions(+), 2 deletions(-) diff --git a/documentation/index.rst b/documentation/index.rst index 46b775711..802f895b4 100644 --- a/documentation/index.rst +++ b/documentation/index.rst @@ -5,10 +5,19 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. +========================================== Welcome to the Yocto Project Documentation ========================================== -| +This is the top level of the Yocto Project documentation tree. The Yocto Project +documentation is always a work in progress, just like the Yocto Project itself. +Improvements to the documentation are always welcome; join the +:yocto_lists:`docs mailing list ` if you want to help out. + +Introduction and Overview +========================= + +Get started using the Yocto Project. .. toctree:: :maxdepth: 1 @@ -20,6 +29,13 @@ Welcome to the Yocto Project Documentation Yocto Project Technical Overview Tips and Tricks Wiki +Manuals +======= + +A collection of manuals covering many aspects of the Yocto Project, including +reference definitions, tutorials, and details about the project's +infrastructure. + .. toctree:: :maxdepth: 1 :caption: Manuals @@ -37,9 +53,14 @@ Welcome to the Yocto Project Documentation Test Environment Manual bitbake +Security Reference +================== + +Security-related processes and contact information for vulnerability reporting. + .. toctree:: :maxdepth: 1 - :caption: Security + :caption: Security Reference Yocto Project Security Reference diff --git a/documentation/sphinx-static/theme_overrides.css b/documentation/sphinx-static/theme_overrides.css index 3cb16dbcc..f9e067239 100644 --- a/documentation/sphinx-static/theme_overrides.css +++ b/documentation/sphinx-static/theme_overrides.css @@ -103,6 +103,10 @@ em { background: #f8f8f8; } +section#welcome-to-the-yocto-project-documentation p.caption { + display: none; +} + @media screen { .wy-nav-content { max-width: 1000px; From patchwork Fri Jul 24 13:24:59 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 93449 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 74F7FC53216 for ; Fri, 24 Jul 2026 13:25:14 +0000 (UTC) Received: from smtpout-02.galae.net (smtpout-02.galae.net [185.246.84.56]) by mx.groups.io with SMTP id smtpd.msgproc01-g2.19147.1784899512549306852 for ; Fri, 24 Jul 2026 06:25:13 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=OC1hGKFv; spf=pass (domain: bootlin.com, ip: 185.246.84.56, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-02.galae.net (Postfix) with ESMTPS id D0F2A1A11E8 for ; Fri, 24 Jul 2026 13:25:10 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id 9991E60395 for ; Fri, 24 Jul 2026 13:25:10 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id F27F611C124EE; Fri, 24 Jul 2026 15:25:09 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1784899510; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=JwOLzSqWzHZCXED23EofBbHLp2nd8u0aa47D8hkcdgY=; b=OC1hGKFvKGt7C6dSAFb+UEcKTdyE5bp6lbq15lNxfxvvSz2Rm3GKj/AtU+QLOk67ZBlkK3 5pgYS6nlioHZH7DwkZyt9Kvwm7xTNLP/cW9WnNrwj8WTPdvTCM6TjBkT/mcl90zBLvdtGb 25EdYHuvyFFxt2eX1avzhExOHxPfannoTBmHGLp6EUj1tDrOipkmNM36ceXla0r2fRedXJ 3by9goLV9+etMvOBjkOdfG1V7nqVkCYgAB8nrU8RCZR6mHTS4ARhpSx0V3oLYyCJtcleu9 Qceio2/LA+Zf/7ZVhVXSiChaijAv9Z2aSjvs/UHFxDeONkpH5QvyPbusm1bLrw== From: Antonin Godard Date: Fri, 24 Jul 2026 15:24:59 +0200 Subject: [PATCH 2/9] index.rst: move the contributor guide out of the Manuals section MIME-Version: 1.0 Message-Id: <20260724-rework-welcome-page-v1-2-491772cc4b65@bootlin.com> References: <20260724-rework-welcome-page-v1-0-491772cc4b65@bootlin.com> In-Reply-To: <20260724-rework-welcome-page-v1-0-491772cc4b65@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard X-Mailer: b4 0.15.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=1412; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=L8i0R/vbb8GS+mC+FbAL7qlOBqAbWkUIHEVRw64Rp48=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBqY2ex3iKcL3SyT6fD/JP6qczNfebfa5QVxFWMK bt9EiSLQ3KJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCamNnsQAKCRDRgEFAKaOo NkKMEAC12pD7i6tPzPplKpv4KgD51seaWZNc8VxcRsuMTQeewvzbPwJvO9wmXmS2aId4upSLgoy AzU780X0vH77boV3Dznmq4XaxPr+qJehvPSLHQ89XArVqKNICIBcSB+Xc2Z0iUNRr2rdZY47tZ3 /hC6I1A/xAn46KoBWIdhasJm1Y6pn85Ngm+uDtp5bgjCl306G/lywDO2e9VWH204/W364ZHyHxF kEwt9vEIwpV19kgnykS2bms3h3oRlJZRKUy44BbO7/YV+nC/hdN0ZnwEtvOEzpBf9z1EyBYRbHn P30LbSfcJs+q3Z9t/0bcMgNtrpQBzqiqeEVGddCr5/YY81vdpkega9DU8fBzN5dcdIz4Tbc48zC WC/1NOjMllpB6K2YBBDuKLvk10yDlrmd/0WHd3s04SK+ZaZm3rNlNqIqaLseY38h5ZSHkLxWIx1 B3I1s3xvfmZ6WBLwc4UHMDf6QUeLP5niKtEGi+z0Bg+9bQFBt+P8n/lQiuqXSzuC5XeNjYod8JV zq8IEK6u9BbRC/xLQjdiMTM6Zs3X57BMrQgK4r5EHXE5tFwET9ZaGjZOU2IT1qRyA7jANWwGP2Y 7mBNKZnW8k72oBOCvsHNm+oS8cyR3skt81CXm/E6DyJkwr3X0Uuk3S/3pmicKsuQgxYJyxX6q6/ 3VAwQtf37nAD1Aw== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-Last-TLS-Session-Version: TLSv1.3 List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 24 Jul 2026 13:25:14 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/10129 In many project, contributing sections are usually separate from the technical documentation and put to the forefront. Let's follow this in yocto-docs by creating a dedicated section for it on the main page. Signed-off-by: Antonin Godard --- documentation/index.rst | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/documentation/index.rst b/documentation/index.rst index 802f895b4..9a5a83811 100644 --- a/documentation/index.rst +++ b/documentation/index.rst @@ -29,6 +29,17 @@ Get started using the Yocto Project. Yocto Project Technical Overview Tips and Tricks Wiki +Contributing to the Yocto Project +================================= + +Guides on how to contribute to the different parts of the Yocto Project. + +.. toctree:: + :maxdepth: 2 + :caption: Contributor Guide + + Contributor Guide + Manuals ======= @@ -41,7 +52,6 @@ infrastructure. :caption: Manuals Overview and Concepts Manual - Contributor Guide Reference Manual Board Support Package (BSP) Developer's guide Development Tasks Manual From patchwork Fri Jul 24 13:25:00 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 93450 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 44A56C53200 for ; Fri, 24 Jul 2026 13:25:14 +0000 (UTC) Received: from smtpout-02.galae.net (smtpout-02.galae.net [185.246.84.56]) by mx.groups.io with SMTP id smtpd.msgproc02-g2.19193.1784899513416184824 for ; Fri, 24 Jul 2026 06:25:13 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=SnqVEQas; spf=pass (domain: bootlin.com, ip: 185.246.84.56, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-02.galae.net (Postfix) with ESMTPS id BFE6C1A11EA for ; Fri, 24 Jul 2026 13:25:11 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id 8DE8060395 for ; Fri, 24 Jul 2026 13:25:11 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id A392C11C124EF; Fri, 24 Jul 2026 15:25:10 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1784899510; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=zEeAgJetQa20GMcmBlXEG1GSLTqWdBD/beLkNpHnipE=; b=SnqVEQas0T4fciisMIgqE0o+8vRtGtO7wxPFgYXU+JuAXmB/LwYf4a3WZBOfZ3UZwNiekC 64Db2hNdwBVWNa9QG7SGg2WcjG0L/Qjd8ZhQAvjuPhxqZ9jMSPvKWMbIHK21x1Ji+fk6PL 3Z1LB1pwPVghMmB1kQYnJGP+lDrs9uRQs8Izr15Ilu4Azdj3ImlELRr1jIDG+PRXrIR2Jp KThpY93mRC23SwbQhPNTySDr9d4HADsmB2sV4u+UdrHd0t/4uM67THRwBuYJxmfvEipJtG S95F9aXk1Unn4nVmwWLLYi9VXBFAOvktYUrh11oyKHJ0XCSXKh2LGb3e+3zfwQ== From: Antonin Godard Date: Fri, 24 Jul 2026 15:25:00 +0200 Subject: [PATCH 3/9] index.rst: move the "Overview and Concepts" manual in the "Introduction and Overview" section MIME-Version: 1.0 Message-Id: <20260724-rework-welcome-page-v1-3-491772cc4b65@bootlin.com> References: <20260724-rework-welcome-page-v1-0-491772cc4b65@bootlin.com> In-Reply-To: <20260724-rework-welcome-page-v1-0-491772cc4b65@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard X-Mailer: b4 0.15.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=1497; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=vigS+xfcMdKxdYE27TGio8ou22KqEv+LDMFbQczDax0=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBqY2exbc1JZRT5ElO5oLir/wFmscileMbEgzoA7 Slf1ptbKQOJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCamNnsQAKCRDRgEFAKaOo Nk5GD/sHtNeXRpUn9Q9KqNVJtXLRA5HP2X5k3Ea1xCsMbdzlMPdAaKjIdl3M185+QsElNEYzLGV QL2kSy/kq3P7vOyee9dRfVlSCMUQ/Qws5Z0bZ14Xqtn8BQo6mIvqDfgJJwVm79jrX65F/rOXyhU SSOu+CJZtBafvNmJfwqbt+UtTyGc474WCdgFUrLFMAL0XzrkN45+KTVM9alWaOViHHDZXY2C8GD Nf81DlnpDORiIdZB8t49wLRgM2A126FDi5UeAmnjrBkPzKAQ3Zn1EcFw5x47kz4ka6q0DGJBgmP sih4P7PhCVRbgVPUMhO0AixiVEhnYu97B99gFxVjq3TdYfjoFNE+H/w7SBFxg77NrakXkGK2NAg kWtR3jxqlXFzNxWQDo1pZtyS1gLPVeVLGpJpf/34lNeYgptQtXtVzKJLDtckggigdH1tF4heX3p cNDRjyA7WluytDNfp7W7tDG5lDCJzJvr6fNuSgHXO0a0aKGhxkJR8mI4+IJQi7VVe+/PfvAOzRz A2JBsnBJzO/0LlaV7KdWAiRcGDQlC0IIYQx/7SqnAPThEGh3rht4RowQyw8H7VseXoItbpB4a5i lDvT+Fcjw8zsTE0N9mMebRY9ESydpNVnDaN81+uGBuC0mJpeiuVCZM/GlH4wBU3e25djbfzwUS7 gG7cA7G3aKXnu8Q== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-Last-TLS-Session-Version: TLSv1.3 List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 24 Jul 2026 13:25:14 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/10131 The Overview and Concepts manual contains introductory content which feels like it should rather be in the first section of the welcome page, rather than the "Manuals" section. Moreover, this section does not feel like a manual either, so rename the section title to "Overview and Concepts". Keep the "-manual" suffix to the directory name to avoid breaking links, though. Signed-off-by: Antonin Godard --- documentation/index.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/documentation/index.rst b/documentation/index.rst index 9a5a83811..b7c04a581 100644 --- a/documentation/index.rst +++ b/documentation/index.rst @@ -29,6 +29,13 @@ Get started using the Yocto Project. Yocto Project Technical Overview Tips and Tricks Wiki +Get familiar with the development environment and concepts of the Yocto Project. + +.. toctree:: + :maxdepth: 2 + + Overview and Concepts + Contributing to the Yocto Project ================================= @@ -51,7 +58,6 @@ infrastructure. :maxdepth: 1 :caption: Manuals - Overview and Concepts Manual Reference Manual Board Support Package (BSP) Developer's guide Development Tasks Manual From patchwork Fri Jul 24 13:25:01 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 93451 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 592B3C531C9 for ; Fri, 24 Jul 2026 13:25:24 +0000 (UTC) Received: from smtpout-02.galae.net (smtpout-02.galae.net [185.246.84.56]) by mx.groups.io with SMTP id smtpd.msgproc01-g2.19149.1784899514045686553 for ; Fri, 24 Jul 2026 06:25:14 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=eRmGsjgv; spf=pass (domain: bootlin.com, ip: 185.246.84.56, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-02.galae.net (Postfix) with ESMTPS id 6BFA51A11EB for ; Fri, 24 Jul 2026 13:25:12 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id 41AF160395 for ; Fri, 24 Jul 2026 13:25:12 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id 601EC11C124E7; Fri, 24 Jul 2026 15:25:11 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1784899511; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=v7/L13ukCX3OP4QsYvVhNvfEPKLFaq9M5e4cfWKpbyQ=; b=eRmGsjgvnekoOT4Y1SL1lPQIG+c/HTfwYkSVgGaaId/ylQY4i110V4a1DhDmI8AkzoOd1c z6ugeWogbE9uR1XGKDRijoxyvJghwp8+2+EKEzT+2jHhPYAoHo0eA4qYSnjGF6dNeJoL87 JcroV7lP8As2dYIMS+dLNXUjQ8LzqCorJsBYRUhvgFC+d3GhbC26xCmHa+u3j/iYy4t1+D 6Co9C/HIcM3CkY8FGtfPkshq7cNF4Z48EgNHErf0L+MomPKEJ5MRkfnB3p4OgVA/Rm/nq4 optVpLGf/sObhUyaFnwgtg0MsAItC9T2ImEmB7JxGeQvSf6g4KhTwGoc8duMxg== From: Antonin Godard Date: Fri, 24 Jul 2026 15:25:01 +0200 Subject: [PATCH 4/9] index.rst: move external links to the bottom of the intro section MIME-Version: 1.0 Message-Id: <20260724-rework-welcome-page-v1-4-491772cc4b65@bootlin.com> References: <20260724-rework-welcome-page-v1-0-491772cc4b65@bootlin.com> In-Reply-To: <20260724-rework-welcome-page-v1-0-491772cc4b65@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard X-Mailer: b4 0.15.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=1844; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=J7wsc7/YhnemzQzD1+MwnV/gxHK7FC/858oGJph6EWI=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBqY2ey9mo3BroaJd8+o/F4Mns/fMJ14EATT5qTd ubKwoQrBPyJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCamNnsgAKCRDRgEFAKaOo NtcyEAC7zBtQx4cg2tM0x3IKifKEHmqCqzmM8JjYqEcg0gFGzzqtPhi9c/mqQsqjXZuuPRXO/gg DEUrfPzT1nEhJgOol9mCbr8ld7pKUNRTDzllsOHIYmwi2KGmzrgDiSz2jR9NLSvg7kOqppCVUu5 sFrwPGxJhv/gIQ+FW4H0b1EKeixTjdg2ne/aueIpoeyKcon7E8yzUPKSn6Yb5wts9UEjjzF2tnS FAO9X1LueZKGyzg7uNudbfokBnb9XnHcVsCeEa2cWqI38VbksKzGKj5HuV/cA4RtrnmMhOnyIhE Mg74RGbx1tLy2XvcGo3W5jHIu/+eI302DlQuOxv8xmNkSChOHm4RRgFtwwDz6bJZGh/SMGDx8N+ WljTYxd0qBefb+pCYLeqSnpSOyn33jK6fCihbShVBImSNaPwtaq6ukxglO3MFp2k9YPL5fCUfVH 1LRcn4BcreTnMZ8Bgzog9sAxhtY9MRM4t20Wy4X5GnB1xhk9JkW/TnbBw+2Cd6ZZjKpQ3lIvn8b YFg34qV+o2uhfC53M04Q01kl4k7MJWuezdAtPOFhHcedxmGr0BHSlln1/EUMW9EijMH5ycoftaL 0tBqMd4CGBOdcxG4QRo5lRJnM5I72jD8Obsg0aLgyJz9YfFLMc6WynMUmYfI6gwhjB9gXlhLlBJ 9C7gvKfjHG0FKfQ== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-Last-TLS-Session-Version: TLSv1.3 List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 24 Jul 2026 13:25:24 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/10132 These two links contain more introductory resources to the project and are external to yocto-docs, but currently break the flow of the introduction: - The "Yocto Project Technical Overview" from https://www.yoctoproject.org is essentially the same as our "Introducing the Yocto Project" section of the Overview and Concepts manual but with less details. - The Tips and Tricks wiki page contains a lot of old and obsolete information, and the wiki is bound to be deprecated at some point. Additionally, hide them from the sidebar by not including them in a toctree. Signed-off-by: Antonin Godard --- documentation/index.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/documentation/index.rst b/documentation/index.rst index b7c04a581..4cc9d4582 100644 --- a/documentation/index.rst +++ b/documentation/index.rst @@ -26,8 +26,6 @@ Get started using the Yocto Project. Quick Build what-i-wish-id-known transitioning-to-a-custom-environment - Yocto Project Technical Overview - Tips and Tricks Wiki Get familiar with the development environment and concepts of the Yocto Project. @@ -36,6 +34,11 @@ Get familiar with the development environment and concepts of the Yocto Project. Overview and Concepts +Additional introductory resources. + +- `Technical Overview (external website) `__ +- `Tips and Tricks Wiki (external website) `__ + Contributing to the Yocto Project ================================= From patchwork Fri Jul 24 13:25:02 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 93456 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 F377CC5321B for ; Fri, 24 Jul 2026 13:25:24 +0000 (UTC) Received: from smtpout-02.galae.net (smtpout-02.galae.net [185.246.84.56]) by mx.groups.io with SMTP id smtpd.msgproc01-g2.19150.1784899514783091440 for ; Fri, 24 Jul 2026 06:25:15 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=bD5LlU0G; spf=pass (domain: bootlin.com, ip: 185.246.84.56, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-02.galae.net (Postfix) with ESMTPS id 1D3791A11E5 for ; Fri, 24 Jul 2026 13:25:13 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id E5E5260395 for ; Fri, 24 Jul 2026 13:25:12 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id 2BE0111C103CD; Fri, 24 Jul 2026 15:25:12 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1784899512; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=HdAyM+iPHAJUlFUGBNEUPXRZ1PVtL7Y4yOuyqiGIZkU=; b=bD5LlU0Gp33QMz5V21SmMbxKpBJhPVW2EehFCzDNbD6IEad8T3CTTt21BLwIUvimGaMrgl CqAuUVGTGpUVJc8xDY9Ej+DeN8+N3bAhZLC7qg1iRK/ZqlXfGQl0bZsih/7K9q1uERdlfc 26PPMldGuog02WtcWR0am5YPgDXmoY5mu50YlsA4f6VQ3/z+GFV1gf+Eu+YiYS2MyYhGtB CckmjMY/M47Jn5TBxowPr+6qwwlJuRPM8EzQ5H71/n1YmPKZqL5B6UJ8WyWHBy9u6sBI9a /SXXKSuLcXo3zrCcC19FhP1HS9uA4Pk68FtTzP2EzW1Gq+jlUplfTE29oN7t0Q== From: Antonin Godard Date: Fri, 24 Jul 2026 15:25:02 +0200 Subject: [PATCH 5/9] overview-manual: move the intro content in the index MIME-Version: 1.0 Message-Id: <20260724-rework-welcome-page-v1-5-491772cc4b65@bootlin.com> References: <20260724-rework-welcome-page-v1-0-491772cc4b65@bootlin.com> In-Reply-To: <20260724-rework-welcome-page-v1-0-491772cc4b65@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard X-Mailer: b4 0.15.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=7574; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=IVlQ2i3KON6/EtJPUALNe2GuTneG2q0feAxiTLgc35M=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBqY2eyqT2RzOCB16zEqoZirOOxfx5Yp5S10aZV4 aehHQBQkPiJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCamNnsgAKCRDRgEFAKaOo NpJGD/9r0iXo9PP0Vy6qzCjiQbh1NvV2RK9ERgLyAK4Mera9gEmG/A/XIHclBdECGrrqLHyw2fE WDFcVzvFlCtXmo9f1npkZZuNQDE/6cm0fwWkGfzc8DgzCarmUy/5Kwn+gwiEiZt4/yFE6D6zhdw FIN4+CNF1oeSLIu0dqUE//lnjTwHv+qT0pYLDb5N9H62+H+fIia/GmdWrTirRJfPCaa+WMeLyu9 Khp19aHzZADG213Inly6MLtMWYsfgS0xSbY+O+yzjppgMM/pJcWZUgAPcfGsqqbFmx6eJhvGO5R qNlhibOGvhOccIM8UPa3Z8ICteZBkLV58qObcSMbvck/q6E8PEdkAOGhukTv/LUDfbHDQQcbSKj sHh7OEGPReGNYJe2HY8P1PD5o+OHmZkSGMHXB21Mk8MvpPVfByiWIDsxUBJwiyXYOL4TmN8z2zR PeST4Prw79hH0YAlXxTWNSv6zduJ9TjGWSsBPDrg16XV1daWrbYtwBik8z6j+ePD9eroAXgtCkF bbUy990qegE9eYfqJRlseiHN0kLyv8CRXNP5bRXkEg2E1jlkEgttMsGnJPUZO1XqCgU1gsu8/L9 68TlKi0EzSgEpsPFG0EVC+jwt5xlGOUe5c9djGFBu3Xkcc+KbHynfnkFgX4p+D35JvRWUHZGDAH kUCiKspXsnOHmDw== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-Last-TLS-Session-Version: TLSv1.3 List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 24 Jul 2026 13:25:24 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/10133 The index document can act as an intro document. Having an extra intro document to this section felt a bit superfluous, now that it is part of the whole "Introduction and Overview" section. Signed-off-by: Antonin Godard --- documentation/overview-manual/index.rst | 59 +++++++++++++++++++++++++++- documentation/overview-manual/intro.rst | 69 --------------------------------- 2 files changed, 57 insertions(+), 71 deletions(-) diff --git a/documentation/overview-manual/index.rst b/documentation/overview-manual/index.rst index 04061f8f4..7d96881b9 100644 --- a/documentation/overview-manual/index.rst +++ b/documentation/overview-manual/index.rst @@ -4,15 +4,70 @@ Yocto Project Overview and Concepts Manual ========================================== -| +Welcome to the Yocto Project Overview and Concepts Manual! This manual +introduces the Yocto Project by providing concepts, software overviews, +best-known-methods (BKMs), and any other high-level introductory +information suitable for a new Yocto Project user. + +Here is what you can get from this manual: + +- :ref:`overview-manual/yp-intro:introducing the yocto project`\ *:* + This chapter provides an introduction to the Yocto Project. You will learn + about features and challenges of the Yocto Project, the layer model, + components and tools, development methods, the + :term:`Poky` reference distribution, the + :term:`OpenEmbedded Build System` workflow, and some basic Yocto terms. + +- :ref:`overview-manual/development-environment:the yocto project development environment`\ *:* + This chapter helps you get started understanding the Yocto Project + development environment. You will learn about open source, development hosts, + Yocto Project source repositories, workflows using Git and the Yocto + Project, a Git primer, and information about licensing. + +- :doc:`/overview-manual/concepts` *:* This + chapter presents various concepts regarding the Yocto Project. You + can find conceptual information about components, development, + cross-toolchains, and so forth. + +This manual does not give you the following: + +- *Step-by-step Instructions for Development Tasks:* Instructional + procedures reside in other manuals within the Yocto Project + documentation set. For example, the :doc:`/dev-manual/index` + provides examples on how to perform + various development tasks. As another example, the + :doc:`/sdk-manual/index` manual contains detailed + instructions on how to install an SDK, which is used to develop + applications for target hardware. + +- *Reference Material:* This type of material resides in an appropriate + reference manual. For example, system variables are documented in the + :doc:`/ref-manual/index`. As another + example, the :doc:`/bsp-guide/index` contains reference information on + BSPs. + +- *Detailed Public Information Not Specific to the Yocto Project:* For + example, exhaustive information on how to use the Source Control + Manager Git is better covered with Internet searches and official Git + Documentation than through the Yocto Project documentation. .. toctree:: :caption: Table of Contents :numbered: - intro yp-intro development-environment concepts +Because this manual presents information for many different topics, +supplemental information is recommended for full comprehension. For +additional introductory information on the Yocto Project, see the +:yocto_home:`Yocto Project Website <>`. If you want to build an image +with no knowledge of Yocto Project as a way of quickly testing it out, +see the :doc:`/brief-yoctoprojectqs/index` document. +For a comprehensive list of links and other documentation, see the +":ref:`Links and Related +Documentation `" +section in the Yocto Project Reference Manual. + .. include:: /boilerplate.rst diff --git a/documentation/overview-manual/intro.rst b/documentation/overview-manual/intro.rst deleted file mode 100644 index ffdbd3f83..000000000 --- a/documentation/overview-manual/intro.rst +++ /dev/null @@ -1,69 +0,0 @@ -.. SPDX-License-Identifier: CC-BY-SA-2.0-UK - -********************************************** -The Yocto Project Overview and Concepts Manual -********************************************** - -Welcome -======= - -Welcome to the Yocto Project Overview and Concepts Manual! This manual -introduces the Yocto Project by providing concepts, software overviews, -best-known-methods (BKMs), and any other high-level introductory -information suitable for a new Yocto Project user. - -Here is what you can get from this manual: - -- :ref:`overview-manual/yp-intro:introducing the yocto project`\ *:* - This chapter provides an introduction to the Yocto Project. You will learn - about features and challenges of the Yocto Project, the layer model, - components and tools, development methods, the - :term:`Poky` reference distribution, the - :term:`OpenEmbedded Build System` workflow, and some basic Yocto terms. - -- :ref:`overview-manual/development-environment:the yocto project development environment`\ *:* - This chapter helps you get started understanding the Yocto Project - development environment. You will learn about open source, development hosts, - Yocto Project source repositories, workflows using Git and the Yocto - Project, a Git primer, and information about licensing. - -- :doc:`/overview-manual/concepts` *:* This - chapter presents various concepts regarding the Yocto Project. You - can find conceptual information about components, development, - cross-toolchains, and so forth. - -This manual does not give you the following: - -- *Step-by-step Instructions for Development Tasks:* Instructional - procedures reside in other manuals within the Yocto Project - documentation set. For example, the :doc:`/dev-manual/index` - provides examples on how to perform - various development tasks. As another example, the - :doc:`/sdk-manual/index` manual contains detailed - instructions on how to install an SDK, which is used to develop - applications for target hardware. - -- *Reference Material:* This type of material resides in an appropriate - reference manual. For example, system variables are documented in the - :doc:`/ref-manual/index`. As another - example, the :doc:`/bsp-guide/index` contains reference information on - BSPs. - -- *Detailed Public Information Not Specific to the Yocto Project:* For - example, exhaustive information on how to use the Source Control - Manager Git is better covered with Internet searches and official Git - Documentation than through the Yocto Project documentation. - -Other Information -================= - -Because this manual presents information for many different topics, -supplemental information is recommended for full comprehension. For -additional introductory information on the Yocto Project, see the -:yocto_home:`Yocto Project Website <>`. If you want to build an image -with no knowledge of Yocto Project as a way of quickly testing it out, -see the :doc:`/brief-yoctoprojectqs/index` document. -For a comprehensive list of links and other documentation, see the -":ref:`Links and Related -Documentation `" -section in the Yocto Project Reference Manual. From patchwork Fri Jul 24 13:25:03 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 93452 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 8CABDC531F9 for ; Fri, 24 Jul 2026 13:25:24 +0000 (UTC) Received: from smtpout-02.galae.net (smtpout-02.galae.net [185.246.84.56]) by mx.groups.io with SMTP id smtpd.msgproc02-g2.19195.1784899516062169208 for ; Fri, 24 Jul 2026 06:25:16 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=RdArbzM2; spf=pass (domain: bootlin.com, ip: 185.246.84.56, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-02.galae.net (Postfix) with ESMTPS id 65CFC1A11E7 for ; Fri, 24 Jul 2026 13:25:14 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id 3AFA760395 for ; Fri, 24 Jul 2026 13:25:14 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id EAB0A11C124F0; Fri, 24 Jul 2026 15:25:12 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1784899513; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=LS3UJyfJEoTGzQ+s2HuTS5NN2puy22siusF1LUCEsR4=; b=RdArbzM2hixNdN8j3nh8qIaL5pcPPXIZRM6xICvgOMX2nLtmUnjt+yPtwGPe5QnU0fYzYM VZtde728euaPP48061rQxNP35/Z5zICI4rBO2ZljcAsDC9Vsy66A7FY59DSDU2gMBnOUgq 5CwlTQ8YTFYz6vZd74b8S7xkyI+mxWu/nTmT8hkX5asv2Og7FeCc/S+qqb9xlrGHrI4Sn3 zRrCSAo/PQizt3yiDPtmxbNzUICMKY0MveyTtu5tSTUhZIeQRgRGlWTj94CPsgTwfpQmrQ d7yKgVMZ2qsSHX/hftfoLl8CyZTM8oOCAULedoU3QhbZ6eVtz2j4nPnhWXgpLA== From: Antonin Godard Date: Fri, 24 Jul 2026 15:25:03 +0200 Subject: [PATCH 6/9] bsp-guide: rename to bsp-manual MIME-Version: 1.0 Message-Id: <20260724-rework-welcome-page-v1-6-491772cc4b65@bootlin.com> References: <20260724-rework-welcome-page-v1-0-491772cc4b65@bootlin.com> In-Reply-To: <20260724-rework-welcome-page-v1-0-491772cc4b65@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard X-Mailer: b4 0.15.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=29674; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=jbvdOTasGYoRr5Y/h5Sqd9oDYoa5qPyKIiias7jOZ48=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBqY2eyXwt03Vioz1FLCEwa7ExhmRtUF0iAPU/EI jTyufnsbbyJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCamNnsgAKCRDRgEFAKaOo Nt/pEAC3sNpXvOM0wp/bl5SzFvPnc7qsNUNSyptwHyBBXsu2PgyF+05WAajMCAlq2VNIYWnQF8q 90l/cPsA7I0LOWpHSr/7Lhm791V/gVh+/jjGV/+VNs8ePXyBJ9yBFYVqVKLF3AB0ZmsMOl4TGGE twmqNmSF6qyalJXgvsbLWJlU7A937aIZijFV2DN+BEabKCKbWUJ1sIkwoy1F+rArR6LMHR+bB/S T+UCTikoek+4dcv7yRHQonSXIAJXGKR12EyZOPzkYx7itvzisQk+ZgYt4/UMRGj7hhqVQxybxTM A/Uqjwqlg9VLwx/0BaxGy+fCGhd9JMtIKzwqSKXo+KCyMfD37r0WXw/HEJUMebxeb0hETAHu27P 983peUrb9Gnr7PbtqoHjFDOPh4RPD2oFrhUDcUX77SKSkmzMaUenWrPBIPFwGf7tSG0UpZFHOW1 ve4V3+All/y/Y8MqVP/Mm3EWGYYFV74T0/7CsXY76ewnJ8dVz603Civv7MpjJsReh6Hs+XTvAVN M1rVu0zqi8M/12l0SJUIzieInWoAVfXIGLPc4MeyRw/iYiyOszYrLJ2kUnjrEh7MRPyynNI+gAN PMyFYnfrJndXwN5/qETp/nbAVXrNyQoONbUcS3AcPG+2lEWgFRbpwiYJthHshImJZc9NF6fm53s S0zvDAznekaVXuw== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-Last-TLS-Session-Version: TLSv1.3 List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 24 Jul 2026 13:25:24 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/10134 Rename the "Yocto Project Board Support Package (BSP) Developer's Guide" section to "Yocto Project Board Support Package (BSP) Manual" to align with other subsections of the "Manuals" section. Signed-off-by: Antonin Godard --- documentation/README | 8 ++--- documentation/bsp-guide/index.rst | 15 --------- documentation/{bsp-guide => bsp-manual}/bsp.rst | 34 ++++++++++----------- .../figures/bsp-dev-flow.png | Bin documentation/bsp-manual/index.rst | 15 +++++++++ documentation/dev-manual/layers.rst | 4 +-- documentation/dev-manual/new-machine.rst | 2 +- documentation/dev-manual/start.rst | 2 +- documentation/dev-manual/upgrading-recipes.rst | 2 +- documentation/index.rst | 2 +- documentation/kernel-dev/advanced.rst | 2 +- documentation/kernel-dev/common.rst | 6 ++-- documentation/migration-guides/migration-2.5.rst | 2 +- documentation/overview-manual/concepts.rst | 2 +- .../overview-manual/development-environment.rst | 4 +-- documentation/overview-manual/index.rst | 2 +- documentation/overview-manual/yp-intro.rst | 4 +-- documentation/ref-manual/faq.rst | 6 ++-- documentation/ref-manual/resources.rst | 2 +- documentation/ref-manual/structure.rst | 2 +- documentation/ref-manual/terms.rst | 4 +-- documentation/standards.md | 6 ++-- .../transitioning-to-a-custom-environment.rst | 2 +- documentation/what-i-wish-id-known.rst | 6 ++-- 24 files changed, 67 insertions(+), 67 deletions(-) diff --git a/documentation/README b/documentation/README index 326930932..1a148df7b 100644 --- a/documentation/README +++ b/documentation/README @@ -19,7 +19,7 @@ Here the folders corresponding to individual manuals: * overview-manual - Yocto Project Overview and Concepts Manual * contributor-guide - Yocto Project and OpenEmbedded Contributor Guide * ref-manual - Yocto Project Reference Manual -* bsp-guide - Yocto Project Board Support Package (BSP) Developer's Guide +* bsp-manual - Yocto Project Board Support Package (BSP) Manual * dev-manual - Yocto Project Development Tasks Manual * kernel-dev - Yocto Project Linux Kernel Development Manual * profile-manual - Yocto Project Profiling and Tracing Manual @@ -309,11 +309,11 @@ It is also possible to refer to another document within yocto-docs with the :doc: directive (c.f. https://www.sphinx-doc.org/en/master/usage/referencing.html#role-doc), e.g.: - For more information, read :doc:`/bsp-guide/index`. + For more information, read :doc:`/bsp-manual/index`. Note that only "absolute" paths (starting with a '/') are allowed. The root -directory of that path is documentation/, that is, :doc:`/bsp-guide/index` -points at documentation/bsp-guide/index.rst. +directory of that path is documentation/, that is, :doc:`/bsp-manual/index` +points at documentation/bsp-manual/index.rst. References ========== diff --git a/documentation/bsp-guide/index.rst b/documentation/bsp-guide/index.rst deleted file mode 100644 index 9a8e034ae..000000000 --- a/documentation/bsp-guide/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. SPDX-License-Identifier: CC-BY-SA-2.0-UK - -===================================================== -Yocto Project Board Support Package Developer's Guide -===================================================== - -| - -.. toctree:: - :caption: Table of Contents - :numbered: - - bsp - -.. include:: /boilerplate.rst diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-manual/bsp.rst similarity index 98% rename from documentation/bsp-guide/bsp.rst rename to documentation/bsp-manual/bsp.rst index 9cf0642d7..25c1a2eb6 100644 --- a/documentation/bsp-guide/bsp.rst +++ b/documentation/bsp-manual/bsp.rst @@ -1,8 +1,8 @@ .. SPDX-License-Identifier: CC-BY-SA-2.0-UK -************************************************** -Board Support Packages (BSP) --- Developer's Guide -************************************************** +************************************************ +Yocto Project Board Support Package (BSP) Manual +************************************************ A Board Support Package (BSP) is a collection of information that defines how to support a particular hardware device, set of devices, or @@ -16,7 +16,7 @@ This guide presents information about BSP layers, defines a structure for components so that BSPs follow a commonly understood layout, discusses how to customize a recipe for a BSP, addresses BSP licensing, and provides information that shows you how to create a BSP -Layer using the :ref:`bitbake-layers ` +Layer using the :ref:`bitbake-layers ` tool. BSP Layers @@ -68,7 +68,7 @@ several "reference" BSPs including the ARM-based Beaglebone and generic versions of both 32-bit and 64-bit IA machines. For information on typical BSP development workflow, see the -:ref:`bsp-guide/bsp:developing a board support package (bsp)` +:ref:`bsp-manual/bsp:developing a board support package (bsp)` section. For more information on how to set up a local copy of source files from a Git repository, see the @@ -136,13 +136,13 @@ Preparing Your Build Host to Work With BSP Layers This section describes how to get your build host ready to work with BSP layers. Once you have the host set up, you can create the layer as described in the -":ref:`bsp-guide/bsp:creating a new bsp layer using the \`\`bitbake-layers\`\` script`" +":ref:`bsp-manual/bsp:creating a new bsp layer using the \`\`bitbake-layers\`\` script`" section. .. note:: For structural information on BSPs, see the - :ref:`bsp-guide/bsp:example filesystem layout` section. + :ref:`bsp-manual/bsp:example filesystem layout` section. #. *Set Up the Build Environment:* Be sure you are set up to use BitBake in a shell. See the ":ref:`dev-manual/start:preparing the build host`" @@ -266,7 +266,7 @@ Before looking at the recommended form for the directory structure inside a BSP layer, you should be aware that there are some requirements in order for a BSP layer to be considered compliant with the Yocto Project. For that list of requirements, see the -":ref:`bsp-guide/bsp:released bsp requirements`" section. +":ref:`bsp-manual/bsp:released bsp requirements`" section. Below is the typical directory structure for a BSP layer. While this basic form represents the standard, realize that the actual layout for @@ -513,10 +513,10 @@ use these kernels and images to get a system running and quickly get started on development tasks. The exact types of binaries present are highly hardware-dependent. The -:ref:`README ` file should be present in the +:ref:`README ` file should be present in the BSP Layer and it explains how to use the images with the target hardware. Additionally, the -:ref:`README.sources ` file should be +:ref:`README.sources ` file should be present to locate the sources used to build the images and provide information on the Metadata. @@ -718,7 +718,7 @@ repository, which contains many BSPs supported by the Yocto Project, is part of the example. For an example that shows how to create a new layer using the tools, see -the ":ref:`bsp-guide/bsp:creating a new bsp layer using the \`\`bitbake-layers\`\` script`" +the ":ref:`bsp-manual/bsp:creating a new bsp layer using the \`\`bitbake-layers\`\` script`" section. The following illustration and list summarize the BSP creation general @@ -737,7 +737,7 @@ workflow. local copies of these supported BSP layers on your system gives you access to layers you might be able to leverage when creating your BSP. For information on how to get these files, see the - ":ref:`bsp-guide/bsp:preparing your build host to work with bsp layers`" + ":ref:`bsp-manual/bsp:preparing your build host to work with bsp layers`" section. #. *Create Your Own BSP Layer Using the bitbake-layers Script:* @@ -747,7 +747,7 @@ workflow. in itself, a special type of layer. The simplest way to create a new BSP layer that is compliant with the Yocto Project is to use the ``bitbake-layers`` script. For information about that script, see the - ":ref:`bsp-guide/bsp:creating a new bsp layer using the \`\`bitbake-layers\`\` script`" + ":ref:`bsp-manual/bsp:creating a new bsp layer using the \`\`bitbake-layers\`\` script`" section. Another example that illustrates a layer is an application. Suppose @@ -761,7 +761,7 @@ workflow. section in the Yocto Project Overview and Concepts Manual. You can also reference the ":ref:`dev-manual/layers:understanding and creating layers`" section in the Yocto Project Development Tasks Manual. For more - information on BSP layers, see the ":ref:`bsp-guide/bsp:bsp layers`" + information on BSP layers, see the ":ref:`bsp-manual/bsp:bsp layers`" section. .. note:: @@ -778,7 +778,7 @@ workflow. - A generic ARM 64 platform (``genericarm64``) When you set up a layer for a new BSP, you should follow a standard - layout. This layout is described in the ":ref:`bsp-guide/bsp:example filesystem layout`" + layout. This layout is described in the ":ref:`bsp-manual/bsp:example filesystem layout`" section. In the standard layout, notice the suggested structure for recipes and configuration information. You can see the standard layout for a BSP by examining any supported @@ -833,7 +833,7 @@ Before looking at BSP requirements, you should consider the following: - The requirements here assume the BSP layer is a well-formed, "legal" layer that can be added to the Yocto Project. For guidelines on creating a layer that meets these base requirements, see the - ":ref:`bsp-guide/bsp:bsp layers`" section in this manual and the + ":ref:`bsp-manual/bsp:bsp layers`" section in this manual and the ":ref:`dev-manual/layers:understanding and creating layers`" section in the Yocto Project Development Tasks Manual. @@ -860,7 +860,7 @@ The requirements for a released BSP that conform to the Yocto Project are: - *Layer Name:* The BSP must have a layer name that follows the Yocto Project standards. For information on BSP layer names, see the - ":ref:`bsp-guide/bsp:bsp layers`" section. + ":ref:`bsp-manual/bsp:bsp layers`" section. - *File System Layout:* When possible, use the same directory names in your BSP layer as listed in the ``recipes.txt`` file, which is found diff --git a/documentation/bsp-guide/figures/bsp-dev-flow.png b/documentation/bsp-manual/figures/bsp-dev-flow.png similarity index 100% rename from documentation/bsp-guide/figures/bsp-dev-flow.png rename to documentation/bsp-manual/figures/bsp-dev-flow.png diff --git a/documentation/bsp-manual/index.rst b/documentation/bsp-manual/index.rst new file mode 100644 index 000000000..37469184e --- /dev/null +++ b/documentation/bsp-manual/index.rst @@ -0,0 +1,15 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +================================================ +Yocto Project Board Support Package (BSP) Manual +================================================ + +| + +.. toctree:: + :caption: Table of Contents + :numbered: + + bsp + +.. include:: /boilerplate.rst diff --git a/documentation/dev-manual/layers.rst b/documentation/dev-manual/layers.rst index dc63478a3..c078d5499 100644 --- a/documentation/dev-manual/layers.rst +++ b/documentation/dev-manual/layers.rst @@ -32,7 +32,7 @@ Follow these general steps to create your layer without using tools: .. note:: - For information on BSP layers, see the ":ref:`bsp-guide/bsp:bsp layers`" + For information on BSP layers, see the ":ref:`bsp-manual/bsp:bsp layers`" section in the Yocto Project Board Specific (BSP) Developer's Guide. #. *Create a new Layer:* Create the directory for your layer. The @@ -166,7 +166,7 @@ Follow these general steps to create your layer without using tools: .. note:: For an explanation of layer hierarchy that is compliant with the - Yocto Project, see the ":ref:`bsp-guide/bsp:example filesystem layout`" + Yocto Project, see the ":ref:`bsp-manual/bsp:example filesystem layout`" section in the Yocto Project Board Support Package (BSP) Developer's Guide. #. *Optionally Test for Compatibility:* If you want permission to use diff --git a/documentation/dev-manual/new-machine.rst b/documentation/dev-manual/new-machine.rst index 469b2d395..b4d29027b 100644 --- a/documentation/dev-manual/new-machine.rst +++ b/documentation/dev-manual/new-machine.rst @@ -15,7 +15,7 @@ that the Yocto Project already supports. manual. For a complete example that shows how to add a new machine, see the -":ref:`bsp-guide/bsp:creating a new bsp layer using the \`\`bitbake-layers\`\` script`" +":ref:`bsp-manual/bsp:creating a new bsp layer using the \`\`bitbake-layers\`\` script`" section in the Yocto Project Board Support Package (BSP) Developer's Guide. diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst index 8fa7f8f38..44604595a 100644 --- a/documentation/dev-manual/start.rst +++ b/documentation/dev-manual/start.rst @@ -280,7 +280,7 @@ are necessary depending on what you want to accomplish. See the following references for information on how to prepare for Board Support Package (BSP) development and kernel development: -- *BSP Development:* See the ":ref:`bsp-guide/bsp:preparing your build host to work with bsp layers`" +- *BSP Development:* See the ":ref:`bsp-manual/bsp:preparing your build host to work with bsp layers`" section in the Yocto Project Board Support Package (BSP) Developer's Guide. diff --git a/documentation/dev-manual/upgrading-recipes.rst b/documentation/dev-manual/upgrading-recipes.rst index d0c322546..cc984bbcc 100644 --- a/documentation/dev-manual/upgrading-recipes.rst +++ b/documentation/dev-manual/upgrading-recipes.rst @@ -237,7 +237,7 @@ repository that you use during build operations. Because you have built the recipe in the past, the layer is likely added to your configuration already. If for some reason, the layer is not added, you could add it easily using the -":ref:`bitbake-layers `" +":ref:`bitbake-layers `" script. For example, suppose you use the ``nano.bb`` recipe from the ``meta-oe`` layer in the ``meta-openembedded`` repository. For this example, assume that the layer has been cloned into following area:: diff --git a/documentation/index.rst b/documentation/index.rst index 4cc9d4582..a1a4b5048 100644 --- a/documentation/index.rst +++ b/documentation/index.rst @@ -62,7 +62,7 @@ infrastructure. :caption: Manuals Reference Manual - Board Support Package (BSP) Developer's guide + Board Support Package (BSP) Manual Development Tasks Manual Linux Kernel Development Manual Security Manual diff --git a/documentation/kernel-dev/advanced.rst b/documentation/kernel-dev/advanced.rst index 9db142a12..b36bea67c 100644 --- a/documentation/kernel-dev/advanced.rst +++ b/documentation/kernel-dev/advanced.rst @@ -458,7 +458,7 @@ supported kernel type. This section overviews the BSP description structure, the aggregation concepts, and presents a detailed example using a BSP supported by the Yocto Project (i.e. BeagleBone Board). For complete information on BSP -layer file hierarchy, see the :doc:`/bsp-guide/index`. +layer file hierarchy, see the :doc:`/bsp-manual/index`. Description Overview ~~~~~~~~~~~~~~~~~~~~ diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst index 136524e63..c2fc3e1fa 100644 --- a/documentation/kernel-dev/common.rst +++ b/documentation/kernel-dev/common.rst @@ -81,7 +81,7 @@ section: see the ":ref:`dev-manual/layers:understanding and creating layers`" section in the Yocto Project Development Tasks Manual and the - ":ref:`bsp-guide/bsp:bsp layers`" section in the Yocto Project Board + ":ref:`bsp-manual/bsp:bsp layers`" section in the Yocto Project Board Support (BSP) Developer's Guide, respectively. For information on how to use the ``bitbake-layers create-layer`` command to quickly set up a layer, see the @@ -176,7 +176,7 @@ section: see the ":ref:`dev-manual/layers:understanding and creating layers`" section in the Yocto Project Development Tasks Manual and the - ":ref:`bsp-guide/bsp:bsp layers`" section in the Yocto Project Board + ":ref:`bsp-manual/bsp:bsp layers`" section in the Yocto Project Board Support (BSP) Developer's Guide, respectively. For information on how to use the ``bitbake-layers create-layer`` command to quickly set up a layer, see the @@ -369,7 +369,7 @@ your layer in the following area:: .. note:: If you are working on a new machine Board Support Package (BSP), be - sure to refer to the :doc:`/bsp-guide/index`. + sure to refer to the :doc:`/bsp-manual/index`. As an example, consider the following append file used by the BSPs in ``meta-yocto-bsp``: diff --git a/documentation/migration-guides/migration-2.5.rst b/documentation/migration-guides/migration-2.5.rst index facf5110b..8e182cd2b 100644 --- a/documentation/migration-guides/migration-2.5.rst +++ b/documentation/migration-guides/migration-2.5.rst @@ -94,7 +94,7 @@ Scripts and Tools Changes cases, they are also limited in scope. The ``bitbake-layers create-layer`` command is a direct replacement for ``yocto-layer``. See the documentation to create a BSP or kernel - recipe in the ":ref:`bsp-guide/bsp:bsp kernel recipe example`" section. + recipe in the ":ref:`bsp-manual/bsp:bsp kernel recipe example`" section. - ``devtool finish``: ``devtool finish`` now exits with an error if there are uncommitted changes or a rebase/am in progress in the diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index b23e0d2b6..73a24d8d3 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst @@ -435,7 +435,7 @@ A BSP layer provides machine configurations that target specific hardware. Everything in this layer is specific to the machine for which you are building the image or the SDK. A common structure or form is defined for BSP layers. You can learn more about this structure in the -:doc:`/bsp-guide/index`. +:doc:`/bsp-manual/index`. .. note:: diff --git a/documentation/overview-manual/development-environment.rst b/documentation/overview-manual/development-environment.rst index 0daaf1c1a..0921139bd 100644 --- a/documentation/overview-manual/development-environment.rst +++ b/documentation/overview-manual/development-environment.rst @@ -102,9 +102,9 @@ are several ways of working in the Yocto Project environment: hardware. To development BSPs, you need to take some additional steps beyond what was described in setting up a development host. - The :doc:`/bsp-guide/index` provides BSP-related development + The :doc:`/bsp-manual/index` provides BSP-related development information. For specifics on development host preparation, see the - ":ref:`bsp-guide/bsp:preparing your build host to work with bsp layers`" + ":ref:`bsp-manual/bsp:preparing your build host to work with bsp layers`" section in the Yocto Project Board Support Package (BSP) Developer's Guide. diff --git a/documentation/overview-manual/index.rst b/documentation/overview-manual/index.rst index 7d96881b9..0061d1a18 100644 --- a/documentation/overview-manual/index.rst +++ b/documentation/overview-manual/index.rst @@ -43,7 +43,7 @@ This manual does not give you the following: - *Reference Material:* This type of material resides in an appropriate reference manual. For example, system variables are documented in the :doc:`/ref-manual/index`. As another - example, the :doc:`/bsp-guide/index` contains reference information on + example, the :doc:`/bsp-manual/index` contains reference information on BSPs. - *Detailed Public Information Not Specific to the Yocto Project:* For diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst index 8c0918943..6e8b72249 100644 --- a/documentation/overview-manual/yp-intro.rst +++ b/documentation/overview-manual/yp-intro.rst @@ -245,7 +245,7 @@ accomplish this through a recipe that is a BitBake append .. note:: For general information on BSP layer structure, see the - :doc:`/bsp-guide/index`. + :doc:`/bsp-manual/index`. The :term:`Source Directory` contains both general layers and BSP layers right out of the box. You @@ -690,7 +690,7 @@ helpful for getting started: ":ref:`dev-manual/layers:understanding and creating layers`" section in the Yocto Project Development Tasks Manual. For a discussion specifically on BSP Layers, see the - ":ref:`bsp-guide/bsp:bsp layers`" section in the Yocto + ":ref:`bsp-manual/bsp:bsp layers`" section in the Yocto Project Board Support Packages (BSP) Developer's Guide. - *Metadata:* A key element of the Yocto Project is the Metadata that diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst index 65d5db5d2..01bea4d57 100644 --- a/documentation/ref-manual/faq.rst +++ b/documentation/ref-manual/faq.rst @@ -363,7 +363,7 @@ Support Package (BSP) layer for it. For more information on how to create a BSP layer, see the ":ref:`dev-manual/layers:understanding and creating layers`" section in the Yocto Project Development Tasks Manual and the -:doc:`/bsp-guide/index`. +:doc:`/bsp-manual/index`. Usually, if the board is not completely exotic, adding support in the Yocto Project is fairly straightforward. @@ -519,7 +519,7 @@ How do I disable the cursor on my touchscreen device? ----------------------------------------------------- You need to create a form factor file as described in the -":ref:`bsp-guide/bsp:miscellaneous bsp-specific recipe files`" section in +":ref:`bsp-manual/bsp:miscellaneous bsp-specific recipe files`" section in the Yocto Project Board Support Packages (BSP) Developer's Guide. Set the ``HAVE_TOUCHSCREEN`` variable equal to one as follows:: @@ -531,7 +531,7 @@ How to always bring up connected network interfaces? The default interfaces file provided by the netbase recipe does not automatically bring up network interfaces. Therefore, you will need to add a BSP-specific netbase that includes an interfaces file. See the -":ref:`bsp-guide/bsp:miscellaneous bsp-specific recipe files`" section in +":ref:`bsp-manual/bsp:miscellaneous bsp-specific recipe files`" section in the Yocto Project Board Support Packages (BSP) Developer's Guide for information on creating these types of miscellaneous recipe files. diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst index bcbc7ebac..d91eec5e0 100644 --- a/documentation/ref-manual/resources.rst +++ b/documentation/ref-manual/resources.rst @@ -144,7 +144,7 @@ Here is a list of resources you might find helpful: allows you to develop projects inside or outside of the Yocto Project environment. -- :doc:`/bsp-guide/bsp`: This guide defines the structure +- :doc:`/bsp-manual/bsp`: This guide defines the structure for BSP components. Having a commonly understood structure encourages standardization. diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst index 315a078f7..2886713d4 100644 --- a/documentation/ref-manual/structure.rst +++ b/documentation/ref-manual/structure.rst @@ -243,7 +243,7 @@ Namely, it contains the distro :term:`configuration file` for Poky: This directory contains the Yocto Project reference hardware Board Support Packages (BSPs). For more information on BSPs, see the -:doc:`/bsp-guide/index`. +:doc:`/bsp-manual/index`. .. _structure-build: diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst index cbe7c88e6..8087dd26b 100644 --- a/documentation/ref-manual/terms.rst +++ b/documentation/ref-manual/terms.rst @@ -57,7 +57,7 @@ universal, the list includes them just in case: :term:`Board Support Package (BSP)` A group of drivers, definitions, and other components that provide support for a specific hardware configuration. For more information on BSPs, see - the :doc:`/bsp-guide/index`. + the :doc:`/bsp-manual/index`. :term:`Build Directory` This term refers to the area used by the OpenEmbedded build system for @@ -365,7 +365,7 @@ universal, the list includes them just in case: more detailed information on layers, see the ":ref:`dev-manual/layers:Understanding and Creating Layers`" section in the Yocto Project Development Tasks Manual. For a - discussion specifically on BSP Layers, see the ":ref:`bsp-guide/bsp:BSP + discussion specifically on BSP Layers, see the ":ref:`bsp-manual/bsp:BSP Layers`" section in the Yocto Project Board Support Packages (BSP) Developer's Guide. diff --git a/documentation/standards.md b/documentation/standards.md index 801efe345..30d48a5bb 100644 --- a/documentation/standards.md +++ b/documentation/standards.md @@ -131,11 +131,11 @@ that most themes only style these two admonitions. The [doc directive](https://www.sphinx-doc.org/en/master/usage/referencing.html#role-doc) allows to refer to another document within yocto-docs, like: - For more information, read :doc:`/bsp-guide/index`. + For more information, read :doc:`/bsp-manual/index`. Note that only "absolute" paths (starting with a '/') are allowed. The root -directory of that path is documentation/, that is, :doc:`/bsp-guide/index` -points at documentation/bsp-guide/index.rst. +directory of that path is documentation/, that is, :doc:`/bsp-manual/index` +points at documentation/bsp-manual/index.rst. ## Adding screenshots diff --git a/documentation/transitioning-to-a-custom-environment.rst b/documentation/transitioning-to-a-custom-environment.rst index c69ab5361..0fd7c950e 100644 --- a/documentation/transitioning-to-a-custom-environment.rst +++ b/documentation/transitioning-to-a-custom-environment.rst @@ -61,7 +61,7 @@ Transitioning to a custom environment for systems development #. **Create your own layer for the BSP you're going to use**. It is not common that you would need to create an entire BSP from scratch unless you have a *really* special device. Even if you are using an existing - BSP, :ref:`create your own layer for the BSP `. For example, given a 64-bit x86-based machine, copy the conf/intel-corei7-64 definition and give the machine a relevant name (think board name, not product name). Make sure diff --git a/documentation/what-i-wish-id-known.rst b/documentation/what-i-wish-id-known.rst index d89f43304..e2ed9aa32 100644 --- a/documentation/what-i-wish-id-known.rst +++ b/documentation/what-i-wish-id-known.rst @@ -49,7 +49,7 @@ contact us with other suggestions. their silicon. These layers have names such as "meta-intel" or "meta-ti". Try not to build layers from scratch. If you do have custom silicon, use one of these layers as a guide or template and familiarize yourself with the - :doc:`/bsp-guide/index`. + :doc:`/bsp-manual/index`. #. **Do not put everything into one layer:** Use different layers to logically separate information in your build. As an @@ -208,8 +208,8 @@ contact us with other suggestions. recipes, and configure the kernel. * **Learn About Board Support Packages (BSPs)**: If you want to learn about - BSPs, see the :doc:`/bsp-guide/index`. This manual also provides an - example BSP creation workflow. See the :doc:`/bsp-guide/bsp` section. + BSPs, see the :doc:`/bsp-manual/index`. This manual also provides an + example BSP creation workflow. See the :doc:`/bsp-manual/bsp` section. * **Learn About Toaster**: Toaster is a web interface to the Yocto Project's OpenEmbedded build system. If you are interested in using this type of From patchwork Fri Jul 24 13:25:04 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 93454 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 AF996C53215 for ; Fri, 24 Jul 2026 13:25:24 +0000 (UTC) Received: from smtpout-02.galae.net (smtpout-02.galae.net [185.246.84.56]) by mx.groups.io with SMTP id smtpd.msgproc01-g2.19153.1784899516709871927 for ; Fri, 24 Jul 2026 06:25:17 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=lcbJAZyw; spf=pass (domain: bootlin.com, ip: 185.246.84.56, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-02.galae.net (Postfix) with ESMTPS id 15E761A11E8 for ; Fri, 24 Jul 2026 13:25:15 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id DEE9660395 for ; Fri, 24 Jul 2026 13:25:14 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id 1604B11C124EF; Fri, 24 Jul 2026 15:25:14 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1784899514; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=shMYKzJeX5ReNOi9lk4Y0EYP8FCfB/zEYih0oJqsZJ4=; b=lcbJAZyw3xjUUNBF1cYpiDSNFtANzFQ741VHrjwGCig4tLOwdUqTj6579l+UMdexDdSjPC 0/C25GITk+ztIQUlSA0gS5lGqEMuN/ZITglfh+Dx78Bhfy7dZk/Agblkh0FNdsBbWKYgl+ 1S+rdiJ+F+GVjWnnz8QEmn3+GoFWgw3n/IUWj4An8yxhWIBxIl4edrXze5KqQrhIDuzrLK iJVEHNCVoLByltGhWFjKwoIO9JVqnVhOZuBfyifM+361tnzW95UPX1GS4lUsUStDSMDqqz MPhlrsRvkiAgiM185L/RDDtWG0LeJoeGnf2LmiUIwmiJECJTNR1eBoEVpujMqg== From: Antonin Godard Date: Fri, 24 Jul 2026 15:25:04 +0200 Subject: [PATCH 7/9] contributor-guide/identify-component.rst: use the same tense as other section MIME-Version: 1.0 Message-Id: <20260724-rework-welcome-page-v1-7-491772cc4b65@bootlin.com> References: <20260724-rework-welcome-page-v1-0-491772cc4b65@bootlin.com> In-Reply-To: <20260724-rework-welcome-page-v1-0-491772cc4b65@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard X-Mailer: b4 0.15.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=931; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=o+mG9RM/6QEio4BY133dj2nSfM/5Isce10IBiGKvjQI=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBqY2eyQiovt3pb8xHybL/mec2qfZAcc7XEP1Zb4 V1gAqmBHH2JAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCamNnsgAKCRDRgEFAKaOo NhzbD/4iaa5sec28Un5D7VNdOzHM95I8d0oNqQWO/UAqqmnDFyRf013gj/zILNTvbkyCMo/KkG0 HFCkD2yzIJZi8gU1R9FxK4Md8MgYK0+NpqJIAMIPV33+bh8cc1u8qu4/3MEaya0D1aIRFs3TwY4 YncOPIkq/B78HwNtUoJsPOJbrbmN9vrzYMHotzNHniMP2kgZ/L+cP+bDdW92wirsqX7cvBBNeo1 EL4qSWfpisikGc+HG4ex2c+st9wkh71yTA2mCCNMtQbVWfLuImDSE6qY9hsgzTynIgGK54cCU9e nACKNdNibc8ElS+4vWLBzGXSOOrvuwMH6FiGSmuL0j4v7yBa28w0kP2EBv49e0JQjEhoAEoDXeD JD6E7VrgDCCsYMqs/OOb8KzdGoWnWPiK53TjtUDuLU1u2M9B7c0jTWB0ns2GetRK3bpbWNbEf3p pGw5kjogmFRsLae0X9zJLziGQk6ZXoEndNA8wLcqQ+fCI+v1nPtZKlD52peiWS/0Il+N5FhKOqs ZXrZsXjgl62cZzbB5BWJ5aF4uj7wbTZZUWOU2jDtvALsjHYow6FS150QbNHbbJyJcKcJIMK+mU1 ZIiNV7iUzG2np1OL8UR+lxQwnQ5E7pv+w9ukovw8YzJykwZ+UFjY7jnXylTVXmnd+WIXk1ADSya kUT4N3etUrb0n+w== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-Last-TLS-Session-Version: TLSv1.3 List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 24 Jul 2026 13:25:24 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/10135 All the other subsections of the Contributor Guide use a participle in their titles, let's do the same here. Signed-off-by: Antonin Godard --- documentation/contributor-guide/identify-component.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/contributor-guide/identify-component.rst b/documentation/contributor-guide/identify-component.rst index 6cf8ed985..1b8e27f36 100644 --- a/documentation/contributor-guide/identify-component.rst +++ b/documentation/contributor-guide/identify-component.rst @@ -1,7 +1,7 @@ .. SPDX-License-Identifier: CC-BY-SA-2.0-UK -Identify the component -********************** +Identifying the component +************************* The Yocto Project and OpenEmbedded ecosystem is built of :term:`layers ` so the first step is to identify the component where the issue likely lies. From patchwork Fri Jul 24 13:25:05 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 93455 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 996F2C53200 for ; Fri, 24 Jul 2026 13:25:24 +0000 (UTC) Received: from smtpout-02.galae.net (smtpout-02.galae.net [185.246.84.56]) by mx.groups.io with SMTP id smtpd.msgproc01-g2.19154.1784899517885235231 for ; Fri, 24 Jul 2026 06:25:18 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=byWktWD2; spf=pass (domain: bootlin.com, ip: 185.246.84.56, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-02.galae.net (Postfix) with ESMTPS id 449991A11E5 for ; Fri, 24 Jul 2026 13:25:16 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id 199A960395 for ; Fri, 24 Jul 2026 13:25:16 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id E01FA11C103CD; Fri, 24 Jul 2026 15:25:14 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1784899515; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=oasjMiKaMFqGfTrRjkLGl8tKxjnP0dzDq8Ij+IcKmjc=; b=byWktWD2NqZr/OgKn2dZefcmhxlusnw12vY0bJ5Ltfq+go25+PPHBmSln8f1C45TYY1KKq 02MX2bSOkun0RQg5cnFaNs0as3mWPJ4L08eL7UzpuqdABYbRvcVf7wTJ+YMvhX6kPoKho2 sfKobPY868ziB7foNHlM3KJCT3B0AnwGoOWY62o/obJ45Nz9naNctOyzRhR09k97gJGujm kahNsYdGAvj1nhfnaBmXj71RxUIVJrFdrDcD8DJ51HEfRoLU6xVOoltGcyAwXb2Dnyws09 vZU4pxSUppt/E4t3m9xcObPhm11w9BBnmcy+B6Kt9pu8APb1WBc4IT+RJwVk9g== From: Antonin Godard Date: Fri, 24 Jul 2026 15:25:05 +0200 Subject: [PATCH 8/9] bitbake.rst: rename section to "BitBake User Manual" MIME-Version: 1.0 Message-Id: <20260724-rework-welcome-page-v1-8-491772cc4b65@bootlin.com> References: <20260724-rework-welcome-page-v1-0-491772cc4b65@bootlin.com> In-Reply-To: <20260724-rework-welcome-page-v1-0-491772cc4b65@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard X-Mailer: b4 0.15.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=1241; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=wE/IyA9wGWONHKNoDQ4SIrjqz2ub0zsvc6/DbzKBrYE=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBqY2eyTYuGfgy1RCeNMSg0QNKX+QIKc0mlSv2H6 bQtXXROoMKJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCamNnsgAKCRDRgEFAKaOo NnObEADDbrPgotF+pwuU2LFZspiF2pHlJUzHI+j3etbFfwQydFYVX6wBX7wBY8nLp+R/3XteMQp 4OC3cc4bA5G8GVW+B4Gpu5Yr9Dx0OP+kEvV5W3GZfr03OFUJMnWDOBPyatwvPAc5oxOPLxJ+qMy hZbRsKVgt+l+v3S+Lr6OBCFbv6psz+b0RvP5s2dEfuGl+C7ElD+3ntnX63Vs/U1aXGaQUkj8LiO 30hFmaidO26Ed/6MSEodqWuWMlWdUz0q6MzgslQYITStkh2g33QCJ3bvC5sZfQUq4cW92AxdgTi D7ymv8OLJciz3JtdQHVg3UAZ9JvwAxBJKroByu2GvEwWqVmCUFo1+v2it6yJ6JSkTYdOGclBHnX 3Xo8CBEeiq+5nrJ+dwS1z81hhQRaojEh6jTsn1hNJDYyP/pNvwKcMnYYKK5XWaEOuYnB0ZiVyYB NQ1fGUqv2PKbzB4pMMa9szhFkBShmxxBLSfYPMJtxdME65JMO0Bx9sFbEeIXed1+r4RgjHeWieU vkIpD2GojumA3vjIH2L/1vWNE2mY1A78SdPOhyxgIGCiQkMiGthBi36U3PbQnfsdlN8QKJeCbbl rJz/rtwYsjXEshIGISzZxeghnebSFaljb01iI27+BZxXtCZtf3W6qtwF5iFVRw7dZrenhxwP0u5 kGg5LY8s1cc77Qg== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-Last-TLS-Session-Version: TLSv1.3 List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 24 Jul 2026 13:25:24 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/10136 This is how the documentation manual is called in the external BitBake documentation so call it that way. Moreover this aligns better with the other subsections of the "Manuals" section. Signed-off-by: Antonin Godard --- documentation/bitbake.rst | 6 +++--- documentation/index.rst | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/documentation/bitbake.rst b/documentation/bitbake.rst index 7702f9322..c9ce8a0fd 100644 --- a/documentation/bitbake.rst +++ b/documentation/bitbake.rst @@ -1,8 +1,8 @@ .. SPDX-License-Identifier: CC-BY-SA-2.0-UK -===================== -BitBake Documentation -===================== +=================== +BitBake User Manual +=================== | diff --git a/documentation/index.rst b/documentation/index.rst index a1a4b5048..c1b577fa2 100644 --- a/documentation/index.rst +++ b/documentation/index.rst @@ -70,7 +70,7 @@ infrastructure. Application Development and the Extensible SDK (eSDK) Toaster Manual Test Environment Manual - bitbake + BitBake User Manual Security Reference ================== From patchwork Fri Jul 24 13:25:06 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 93453 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 F372AC53219 for ; Fri, 24 Jul 2026 13:25:24 +0000 (UTC) Received: from smtpout-02.galae.net (smtpout-02.galae.net [185.246.84.56]) by mx.groups.io with SMTP id smtpd.msgproc02-g2.19197.1784899519110229588 for ; Fri, 24 Jul 2026 06:25:19 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=ileOhb0r; spf=pass (domain: bootlin.com, ip: 185.246.84.56, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-02.galae.net (Postfix) with ESMTPS id 756E71A11E7 for ; Fri, 24 Jul 2026 13:25:17 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id 40C3760395 for ; Fri, 24 Jul 2026 13:25:17 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id 208C511C124E7; Fri, 24 Jul 2026 15:25:16 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1784899516; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=bsHY7Ot9guhzC0i5ZGMMVq1T1UY/eosmNLIb5NxLquk=; b=ileOhb0rtLvhW5e4eKVyihdnpxtTHG5+NUNcYHOeXLKzJGErh8RNj+s1axUfbC4OhkgWFV y+dDCPfimVfCKwJwUI/efJMeW/cZ44ueM9rm1zuwAQlR6fJm1ncaJAGq4VwJ/J7ou9zTKc oC7aL/ROilgRiVYfz1qVZXLiNQELiJt8vhOzFb4GXI9k6LYzAsYSjozk8c7sgbPPGEmKnA wKbqtLzqSt1rEYC+i1fPcFFL9A2Y8C32TPkIyIO8XogEZI8ZIXEi1xOFMN0JOZ2z+ca4Lg p1W65yNezwQo5i02H46L3C7Vx3mlzHhpDbfswgZhizDBj56lOSZG0VK6hwgudQ== From: Antonin Godard Date: Fri, 24 Jul 2026 15:25:06 +0200 Subject: [PATCH 9/9] index.rst: move release notes in their own section MIME-Version: 1.0 Message-Id: <20260724-rework-welcome-page-v1-9-491772cc4b65@bootlin.com> References: <20260724-rework-welcome-page-v1-0-491772cc4b65@bootlin.com> In-Reply-To: <20260724-rework-welcome-page-v1-0-491772cc4b65@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard X-Mailer: b4 0.15.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=1301; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=8WLfurY243bEnw/LAw3bpBjNczo2SE7CPKo1Mn3S9qw=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBqY2ez6EjEioZLnphYwfhv7znW0Lhhm3l5YwMK6 n20XY49bYKJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCamNnswAKCRDRgEFAKaOo NviqD/9r+5RxwdIwN8VatinzsqlhegyzB0An5FvUtNvSYeInsKIvxkKiIORQMQ4/4RYzeEMlS8m 2hMR4//o+dTzllpcZhpg26c2uIy2MP12Q70tOo48Z8hXG/MgrqbMcyB4f81GnyDklrHtcYuXJFw ZqhAROYrca7XrVcZLgrL/hCgv7r8zAFXuVtXa1thq8pr55gD8WcJog6JmSe2lkDz7wfXLCHjaoS Z3kw/ETAucSJmFnd+u1XoLOMNBCiiSaGRqREbwa33J+vJAsLfgoz7rId7azzPQ6RXt799yupweF 84my1yeePVK9PfsFgQbdzO4qNgGe7H8x8JeG/IbqRNlB1d1VVcfZzSqsiDJrSI7sac3jETDHgo0 tfJmsng9IVYxadxzxI1mwhcCanwcn6bAji7fQ4m2JYFI8L7YhySVjUmOzuAtsFVRwdGDyf/L/d0 gYdWA2NU8CTtuiBTHQ/Krpys0JcE0xfxak9ej5/EipmNqPo5dWC+3ntueIgZgc4uj5I0tRam7id jhscDNIIIQtpJN37wYL4OguXYSjml3xEYM8HIfm3FakPXQywpRwYL14wsEeIk/yt8p9S0gBUVQV rrx8u05Mz6yo72W5Qf/AVsnMLrTmGzoPkIeZvOAFOoHnopWRRHN5VJtfmQLBSBYnO0MU/Ak7pRy DYWXHwGmvynKD5g== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-Last-TLS-Session-Version: TLSv1.3 List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 24 Jul 2026 13:25:24 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/10137 The release notes are currently hidden in the welcome page, under the "Release Manuals" section, but these changelogs/migration guides are not release manuals per say. Move them out of the "Release Manuals" section under their own "Release Information" section, and make them appear as a "Release Notes and Migration Guides" section in the welcome page. Signed-off-by: Antonin Godard --- documentation/index.rst | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/documentation/index.rst b/documentation/index.rst index c1b577fa2..afabb6615 100644 --- a/documentation/index.rst +++ b/documentation/index.rst @@ -83,12 +83,22 @@ Security-related processes and contact information for vulnerability reporting. Yocto Project Security Reference +Release Information +=================== + +Release notes and migration guides for the different Yocto Project releases. + +.. toctree:: + :maxdepth: 2 + :caption: Release Information + + Release Notes and Migration Guides + .. toctree:: :maxdepth: 1 :caption: Release Manuals :hidden: - Release Information releases .. toctree::