Yocto Project Documentation
 help / color / mirror / Atom feed
From: "Antonin Godard" <antonin.godard@bootlin.com>
To: <quentin.schulz@cherry.de>, <docs@lists.yoctoproject.org>
Cc: "Thomas Petazzoni" <thomas.petazzoni@bootlin.com>
Subject: Re: [docs] [PATCH 5/5] sdk-manual/intro.rst: detail differences between standard and extensible sysroots
Date: Fri, 31 Jul 2026 10:56:54 +0200	[thread overview]
Message-ID: <DKCMQY8VIU9R.23GVR5E2BW4AA@bootlin.com> (raw)
In-Reply-To: <c4107ff7-d2db-4da6-93fd-4eb850403f31@cherry.de>

Hi,

On Thu Jul 30, 2026 at 1:39 PM CEST, Quentin Schulz via lists.yoctoproject.org wrote:
> Hi Antonin,
>
> On 7/29/26 12:02 PM, 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]
>> 
>> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
>> ---
>>   documentation/sdk-manual/intro.rst | 15 +++++++++++++++
>>   1 file changed, 15 insertions(+)
>> 
>> diff --git a/documentation/sdk-manual/intro.rst b/documentation/sdk-manual/intro.rst
>> index 8ccbcfa20..2e5f73f0b 100644
>> --- a/documentation/sdk-manual/intro.rst
>> +++ b/documentation/sdk-manual/intro.rst
>> @@ -123,6 +123,21 @@ 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 sysroot differ in content:
>> +
>
> Why did we stop referring to the Sysroot term (:term:`Sysroot`)?

I can keep referring to it, but thought the first reference was enough. Will try
to refer to it when I can.

>> +-  The standard SDK sysroot only contains libraries and headers for the packages
>
> s/for/of/?
>
> I think we should also mention this brings the libraries and headers of 
> their dependencies (recursively) as well?

Correct, I'll add that

>> +   found in the :term:`TOOLCHAIN_TARGET_TASK` and :term:`TOOLCHAIN_HOST_TASK`
>> +   definitions, for the target and native sysroots respectively.
>> +
>
> I know we have a nativesdk OVERRIDE, so is it still a native/target 
> sysroot or should it be named nativesdk too (I've never built an SDK so 
> I don't know).

So here saying "native sysroot" makes sense if you're only look at the SDK.
Under yocto it's true that we have a distinction between native and nativesdk,
so maybe replacing "native" by "host" here would avoid the confusion in any
case. Will do

>> +   See :doc:`/sdk-manual/appendix-customizing-standard` to learn how to
>> +   customize it.
>> +
>> +-  The extensible SDK sysroot is completely managed by the ``devtool``
>
> Can we maybe point at some docs for devtool? From a quick grep, maybe 
> something in documentation/ref-manual/devtool-reference.rst?

Agreed, will add that

>> +   command-line tool, and its content is the same as the sysroot of the image
>> +   recipe for which the SDK was built.
>> +
>
> I guess we could show how to do this here?
>
> I think it should be something like:
>
> bitbake my-image -c populate_sdk
>
> (or maybe point at 
> https://docs.yoctoproject.org/sdk-manual/appendix-obtain.html#building-an-sdk-installer 
> ?).

Since there are already references to appendix-obtain and appendix-customizing I
think it's already enough?

>> +   See :doc:`/sdk-manual/appendix-customizing` to learn how to customize it.
>> +
>
> Thinking about it, we probably should update 
> documentation/ref-manual/terms.rst for the Sysroot entry in the glossary 
> to explain sysroot for the SDKs (or at the very least point at the 
> section here).

I'll see what could be done

Thanks!
Antonin


      reply	other threads:[~2026-07-31  8:57 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-07-29 10:02 [PATCH 0/5] Make the SDK section not specific to the eSDK Antonin Godard
2026-07-29 10:02 ` [PATCH 1/5] sdk-manual/appendix-customizing-standard.rst: use code block for bitbake assignment Antonin Godard
2026-07-30 10:14   ` [docs] " Quentin Schulz
2026-07-29 10:02 ` [PATCH 2/5] sdk-manual/intro.rst: remove a confusing sentence Antonin Godard
2026-07-30 10:21   ` [docs] " Quentin Schulz
2026-07-29 10:02 ` [PATCH 3/5] sdk-manual/intro.rst: link to sysroot term Antonin Godard
2026-07-30 10:24   ` [docs] " Quentin Schulz
2026-07-29 10:02 ` [PATCH 4/5] sdk-manual: rename the section to remove "extensible" Antonin Godard
2026-07-30 10:29   ` [docs] " Quentin Schulz
2026-07-31  8:56     ` Antonin Godard
2026-07-29 10:02 ` [PATCH 5/5] sdk-manual/intro.rst: detail differences between standard and extensible sysroots Antonin Godard
2026-07-30 11:39   ` [docs] " Quentin Schulz
2026-07-31  8:56     ` Antonin Godard [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=DKCMQY8VIU9R.23GVR5E2BW4AA@bootlin.com \
    --to=antonin.godard@bootlin.com \
    --cc=docs@lists.yoctoproject.org \
    --cc=quentin.schulz@cherry.de \
    --cc=thomas.petazzoni@bootlin.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox