* [PATCH v2 0/5] Make the SDK section not specific to the eSDK
@ 2026-07-31 9:19 Antonin Godard
2026-07-31 9:19 ` [PATCH v2 1/5] sdk-manual/appendix-customizing-standard.rst: use code block for bitbake assignment Antonin Godard
` (5 more replies)
0 siblings, 6 replies; 9+ messages in thread
From: Antonin Godard @ 2026-07-31 9:19 UTC (permalink / raw)
To: docs; +Cc: Thomas Petazzoni
While the content of the SDK section covers both the standard and the
extensible SDKs, the title only referred to the extensible SDK which is
confusing.
This series comes with other various patches to improve this section.
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
Changes in v2:
- Apply suggestions from Quentin (thanks!)
- Link to v1: https://patch.msgid.link/20260729-sdk-clarifications-v1-0-661e65201bc7@bootlin.com
---
Antonin Godard (5):
sdk-manual/appendix-customizing-standard.rst: use code block for bitbake assignment
sdk-manual/intro.rst: remove a confusing sentence
sdk-manual/intro.rst: link to sysroot term
sdk-manual: rename the section to remove "extensible"
sdk-manual/intro.rst: detail differences between standard and extensible sysroots
documentation/index.rst | 2 +-
.../sdk-manual/appendix-customizing-standard.rst | 11 +++----
documentation/sdk-manual/index.rst | 6 ++--
documentation/sdk-manual/intro.rst | 35 ++++++++++++++++------
4 files changed, 36 insertions(+), 18 deletions(-)
---
base-commit: 41dae3c3da3ada1745fc60228ff6269c64ee2361
change-id: 20260529-sdk-clarifications-9aab0fa9a60e
^ permalink raw reply [flat|nested] 9+ messages in thread
* [PATCH v2 1/5] sdk-manual/appendix-customizing-standard.rst: use code block for bitbake assignment
2026-07-31 9:19 [PATCH v2 0/5] Make the SDK section not specific to the eSDK Antonin Godard
@ 2026-07-31 9:19 ` Antonin Godard
2026-07-31 9:19 ` [PATCH v2 2/5] sdk-manual/intro.rst: remove a confusing sentence Antonin Godard
` (4 subsequent siblings)
5 siblings, 0 replies; 9+ messages in thread
From: Antonin Godard @ 2026-07-31 9:19 UTC (permalink / raw)
To: docs; +Cc: Thomas Petazzoni
Use a code block for the DISTRO_FEATURES assignment instead of how it
appears as regular text currently.
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
documentation/sdk-manual/appendix-customizing-standard.rst | 11 ++++++-----
1 file changed, 6 insertions(+), 5 deletions(-)
diff --git a/documentation/sdk-manual/appendix-customizing-standard.rst b/documentation/sdk-manual/appendix-customizing-standard.rst
index c619c15e4..90b73dc20 100644
--- a/documentation/sdk-manual/appendix-customizing-standard.rst
+++ b/documentation/sdk-manual/appendix-customizing-standard.rst
@@ -27,8 +27,9 @@ Adding API Documentation to the Standard SDK
You can include API documentation as well as any other documentation
provided by recipes with the standard SDK by adding "api-documentation"
-to the
-:term:`DISTRO_FEATURES`
-variable: DISTRO_FEATURES:append = " api-documentation" Setting this
-variable as shown here causes the OpenEmbedded build system to build the
-documentation and then include it in the standard SDK.
+to the :term:`DISTRO_FEATURES` variable::
+
+ DISTRO_FEATURES:append = " api-documentation"
+
+Setting this variable as shown here causes the OpenEmbedded build system to
+build the documentation and then include it in the standard SDK.
--
2.55.0
^ permalink raw reply related [flat|nested] 9+ messages in thread
* [PATCH v2 2/5] sdk-manual/intro.rst: remove a confusing sentence
2026-07-31 9:19 [PATCH v2 0/5] Make the SDK section not specific to the eSDK Antonin Godard
2026-07-31 9:19 ` [PATCH v2 1/5] sdk-manual/appendix-customizing-standard.rst: use code block for bitbake assignment Antonin Godard
@ 2026-07-31 9:19 ` Antonin Godard
2026-07-31 9:19 ` [PATCH v2 3/5] sdk-manual/intro.rst: link to sysroot term Antonin Godard
` (3 subsequent siblings)
5 siblings, 0 replies; 9+ messages in thread
From: Antonin Godard @ 2026-07-31 9:19 UTC (permalink / raw)
To: docs; +Cc: Thomas Petazzoni
I have a hard time understanding the meaning of this sentence at this
point in the manual. populate_sdk and populate_sdk_ext are best known as
tasks, so the meaning for them as "archives" is unclear.
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
documentation/sdk-manual/intro.rst | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
diff --git a/documentation/sdk-manual/intro.rst b/documentation/sdk-manual/intro.rst
index dd2902cc4..3e78219fc 100644
--- a/documentation/sdk-manual/intro.rst
+++ b/documentation/sdk-manual/intro.rst
@@ -35,9 +35,7 @@ destined to run on some target machine. SDKs are completely
self-contained. The binaries are linked against their own copy of
``libc``, which results in no dependencies on the target system. To
achieve this, the pointer to the dynamic loader is configured at install
-time since that path cannot be dynamically altered. This is the reason
-for a wrapper around the ``populate_sdk`` and ``populate_sdk_ext``
-archives.
+time since that path cannot be dynamically altered.
Another feature of the SDKs is that only one set of cross-compiler
toolchain binaries are produced for any given architecture. This feature
--
2.55.0
^ permalink raw reply related [flat|nested] 9+ messages in thread
* [PATCH v2 3/5] sdk-manual/intro.rst: link to sysroot term
2026-07-31 9:19 [PATCH v2 0/5] Make the SDK section not specific to the eSDK Antonin Godard
2026-07-31 9:19 ` [PATCH v2 1/5] sdk-manual/appendix-customizing-standard.rst: use code block for bitbake assignment Antonin Godard
2026-07-31 9:19 ` [PATCH v2 2/5] sdk-manual/intro.rst: remove a confusing sentence Antonin Godard
@ 2026-07-31 9:19 ` Antonin Godard
2026-07-31 9:19 ` [PATCH v2 4/5] sdk-manual: rename the section to remove "extensible" Antonin Godard
` (2 subsequent siblings)
5 siblings, 0 replies; 9+ messages in thread
From: Antonin Godard @ 2026-07-31 9:19 UTC (permalink / raw)
To: docs; +Cc: Thomas Petazzoni
Link to the definition of a sysroot (from our glossary) when it is first
introduced and later in the "Sysroots" section.
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
documentation/sdk-manual/intro.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/documentation/sdk-manual/intro.rst b/documentation/sdk-manual/intro.rst
index 3e78219fc..53246bd9a 100644
--- a/documentation/sdk-manual/intro.rst
+++ b/documentation/sdk-manual/intro.rst
@@ -45,7 +45,7 @@ environment script and contained in variables such as
:term:`CC` and
:term:`LD`. This reduces the space needed
for the tools. Understand, however, that every target still needs its own
-sysroot because those binaries are target-specific.
+:term:`sysroot` because those binaries are target-specific.
The SDK development environment consists of the following:
@@ -117,7 +117,7 @@ cross-toolchain works with a matching target sysroot.
Sysroots
--------
-The native and target sysroots contain needed headers and libraries for
+The native and target :term:`sysroots <Sysroot>` contain needed headers and libraries for
generating binaries that run on the target architecture. The target
sysroot is based on the target root filesystem image that is built by
the OpenEmbedded build system and uses the same metadata configuration
--
2.55.0
^ permalink raw reply related [flat|nested] 9+ messages in thread
* [PATCH v2 4/5] sdk-manual: rename the section to remove "extensible"
2026-07-31 9:19 [PATCH v2 0/5] Make the SDK section not specific to the eSDK Antonin Godard
` (2 preceding siblings ...)
2026-07-31 9:19 ` [PATCH v2 3/5] sdk-manual/intro.rst: link to sysroot term Antonin Godard
@ 2026-07-31 9:19 ` Antonin Godard
2026-08-06 8:45 ` [docs] " Quentin Schulz
2026-07-31 9:19 ` [PATCH v2 5/5] sdk-manual/intro.rst: detail differences between standard and extensible sysroots Antonin Godard
2026-08-13 12:01 ` [PATCH v2 0/5] Make the SDK section not specific to the eSDK Antonin Godard
5 siblings, 1 reply; 9+ messages in thread
From: Antonin Godard @ 2026-07-31 9:19 UTC (permalink / raw)
To: docs; +Cc: Thomas Petazzoni
The SDK manual covers both the standard and extensible SDKs yet the
title does not imply that, so rename the section to "Yocto Project
Application Development and the Software Development Kit (SDK) Manual".
As a consequence, rename the first section title and reword the intro.
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
documentation/index.rst | 2 +-
documentation/sdk-manual/index.rst | 6 +++---
documentation/sdk-manual/intro.rst | 8 ++++----
3 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/documentation/index.rst b/documentation/index.rst
index afabb6615..24a6802a4 100644
--- a/documentation/index.rst
+++ b/documentation/index.rst
@@ -67,7 +67,7 @@ infrastructure.
Linux Kernel Development Manual <kernel-dev/index>
Security Manual <security-manual/index>
Profile and Tracing Manual <profile-manual/index>
- Application Development and the Extensible SDK (eSDK) <sdk-manual/index>
+ Application Development and SDKs Manual <sdk-manual/index>
Toaster Manual <toaster-manual/index>
Test Environment Manual <test-manual/index>
BitBake User Manual <bitbake>
diff --git a/documentation/sdk-manual/index.rst b/documentation/sdk-manual/index.rst
index dc7186b91..a5c35caba 100644
--- a/documentation/sdk-manual/index.rst
+++ b/documentation/sdk-manual/index.rst
@@ -1,8 +1,8 @@
.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
-========================================================================================
-Yocto Project Application Development and the Extensible Software Development Kit (eSDK)
-========================================================================================
+=====================================================================================
+Yocto Project Application Development and Software Development Kits (SDK/eSDK) Manual
+=====================================================================================
|
diff --git a/documentation/sdk-manual/intro.rst b/documentation/sdk-manual/intro.rst
index 53246bd9a..b78248d54 100644
--- a/documentation/sdk-manual/intro.rst
+++ b/documentation/sdk-manual/intro.rst
@@ -4,11 +4,11 @@
Introduction
************
-eSDK Introduction
-=================
+SDK/eSDK Introduction
+=====================
-Welcome to the Yocto Project Application Development and the Extensible
-Software Development Kit (eSDK) manual. This manual
+Welcome to the Yocto Project Application Development and
+Software Development Kits (SDK/eSDK) manual. This manual
explains how to use both the Yocto Project extensible and standard
SDKs to develop applications and images.
--
2.55.0
^ permalink raw reply related [flat|nested] 9+ messages in thread
* [PATCH v2 5/5] sdk-manual/intro.rst: detail differences between standard and extensible sysroots
2026-07-31 9:19 [PATCH v2 0/5] Make the SDK section not specific to the eSDK Antonin Godard
` (3 preceding siblings ...)
2026-07-31 9:19 ` [PATCH v2 4/5] sdk-manual: rename the section to remove "extensible" Antonin Godard
@ 2026-07-31 9:19 ` Antonin Godard
2026-08-06 8:48 ` [docs] " Quentin Schulz
2026-08-13 12:01 ` [PATCH v2 0/5] Make the SDK section not specific to the eSDK Antonin Godard
5 siblings, 1 reply; 9+ messages in thread
From: Antonin Godard @ 2026-07-31 9:19 UTC (permalink / raw)
To: docs; +Cc: Thomas Petazzoni
The sysroot in the standard and the extensible SDKs are managed
differently. Detail this in the Sysroots section.
[YOCTO #14830]
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
documentation/sdk-manual/intro.rst | 19 +++++++++++++++++++
1 file changed, 19 insertions(+)
diff --git a/documentation/sdk-manual/intro.rst b/documentation/sdk-manual/intro.rst
index b78248d54..c8fa8d619 100644
--- a/documentation/sdk-manual/intro.rst
+++ b/documentation/sdk-manual/intro.rst
@@ -123,6 +123,25 @@ sysroot is based on the target root filesystem image that is built by
the OpenEmbedded build system and uses the same metadata configuration
used to build the cross-toolchain.
+However, the extensible and standard SDKs :term:`sysroots <Sysroot>` differ in content:
+
+- The standard SDK :term:`sysroot` only contains libraries and headers for the packages
+ --- and their dependencies --- found in the :term:`TOOLCHAIN_TARGET_TASK`
+ and :term:`TOOLCHAIN_HOST_TASK` definitions, for the target and host
+ :term:`sysroots <sysroot>` respectively.
+
+ See :doc:`/sdk-manual/appendix-obtain` to learn how to build it and
+ :doc:`/sdk-manual/appendix-customizing-standard` to learn how to customize
+ it.
+
+- The extensible SDK :term:`sysroot` is completely managed by the :doc:`devtool
+ </ref-manual/devtool-reference>` command-line tool, and its content is the
+ same as the :term:`sysroot` of the image recipe for which the SDK was built.
+
+ See :doc:`/sdk-manual/appendix-obtain` to learn how to build it and
+ :doc:`/sdk-manual/appendix-customizing` to learn how to customize
+ it.
+
The QEMU Emulator
-----------------
--
2.55.0
^ permalink raw reply related [flat|nested] 9+ messages in thread
* Re: [docs] [PATCH v2 4/5] sdk-manual: rename the section to remove "extensible"
2026-07-31 9:19 ` [PATCH v2 4/5] sdk-manual: rename the section to remove "extensible" Antonin Godard
@ 2026-08-06 8:45 ` Quentin Schulz
0 siblings, 0 replies; 9+ messages in thread
From: Quentin Schulz @ 2026-08-06 8:45 UTC (permalink / raw)
To: antonin.godard, docs; +Cc: Thomas Petazzoni
Hi Antonin,
On 7/31/26 11:19 AM, Antonin Godard via lists.yoctoproject.org wrote:
> The SDK manual covers both the standard and extensible SDKs yet the
> title does not imply that, so rename the section to "Yocto Project
> Application Development and the Software Development Kit (SDK) Manual".
>
> As a consequence, rename the first section title and reword the intro.
>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Thanks!
Quentin
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [docs] [PATCH v2 5/5] sdk-manual/intro.rst: detail differences between standard and extensible sysroots
2026-07-31 9:19 ` [PATCH v2 5/5] sdk-manual/intro.rst: detail differences between standard and extensible sysroots Antonin Godard
@ 2026-08-06 8:48 ` Quentin Schulz
0 siblings, 0 replies; 9+ messages in thread
From: Quentin Schulz @ 2026-08-06 8:48 UTC (permalink / raw)
To: antonin.godard, docs; +Cc: Thomas Petazzoni
Hi Antonin,
On 7/31/26 11:19 AM, Antonin Godard via lists.yoctoproject.org wrote:
> The sysroot in the standard and the extensible SDKs are managed
> differently. Detail this in the Sysroots section.
>
> [YOCTO #14830]
>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Thanks!
Quentin
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [PATCH v2 0/5] Make the SDK section not specific to the eSDK
2026-07-31 9:19 [PATCH v2 0/5] Make the SDK section not specific to the eSDK Antonin Godard
` (4 preceding siblings ...)
2026-07-31 9:19 ` [PATCH v2 5/5] sdk-manual/intro.rst: detail differences between standard and extensible sysroots Antonin Godard
@ 2026-08-13 12:01 ` Antonin Godard
5 siblings, 0 replies; 9+ messages in thread
From: Antonin Godard @ 2026-08-13 12:01 UTC (permalink / raw)
To: docs, Antonin Godard; +Cc: Thomas Petazzoni
Applied, thanks!
[1/5] sdk-manual/appendix-customizing-standard.rst: use code block for bitbake assignment
commit: 99768ead76777c12d48f5b00e9d21808c3d2642a
[2/5] sdk-manual/intro.rst: remove a confusing sentence
commit: 21c43225d6775887ea4b85531afb7c08a550e7b6
[3/5] sdk-manual/intro.rst: link to sysroot term
commit: 084f1f14cdbb04c5cbb520b29d2aea78c309a624
[4/5] sdk-manual: rename the section to remove "extensible"
commit: 537f079c14744216cea8cad615df2ea469ef0182
[5/5] sdk-manual/intro.rst: detail differences between standard and extensible sysroots
commit: 17454b7565f15325b2805717167451a9a13427a7
^ permalink raw reply [flat|nested] 9+ messages in thread
end of thread, other threads:[~2026-08-13 12:02 UTC | newest]
Thread overview: 9+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-07-31 9:19 [PATCH v2 0/5] Make the SDK section not specific to the eSDK Antonin Godard
2026-07-31 9:19 ` [PATCH v2 1/5] sdk-manual/appendix-customizing-standard.rst: use code block for bitbake assignment Antonin Godard
2026-07-31 9:19 ` [PATCH v2 2/5] sdk-manual/intro.rst: remove a confusing sentence Antonin Godard
2026-07-31 9:19 ` [PATCH v2 3/5] sdk-manual/intro.rst: link to sysroot term Antonin Godard
2026-07-31 9:19 ` [PATCH v2 4/5] sdk-manual: rename the section to remove "extensible" Antonin Godard
2026-08-06 8:45 ` [docs] " Quentin Schulz
2026-07-31 9:19 ` [PATCH v2 5/5] sdk-manual/intro.rst: detail differences between standard and extensible sysroots Antonin Godard
2026-08-06 8:48 ` [docs] " Quentin Schulz
2026-08-13 12:01 ` [PATCH v2 0/5] Make the SDK section not specific to the eSDK Antonin Godard
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.