Re: [docs] [PATCH 5/5] sdk-manual/intro.rst: detail differences between standard and extensible sysroots

"Antonin Godard" <[email protected]> Fri, 31 Jul 2026 10:56:54 +0200
Newsgroups org.yoctoproject.lists.docs
Message-ID <[email protected]>
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.
>>=20
>> [YOCTO #14830]
>>=20
>> Signed-off-by: Antonin Godard <[email protected]>
>> ---
>>   documentation/sdk-manual/intro.rst | 15 +++++++++++++++
>>   1 file changed, 15 insertions(+)
>>=20
>> diff --git a/documentation/sdk-manual/intro.rst b/documentation/sdk-manu=
al/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 imag=
e that is built by
>>   the OpenEmbedded build system and uses the same metadata configuration
>>   used to build the cross-toolchain.
>>  =20
>> +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. Wil=
l 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=
=20
> 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=20
> sysroot or should it be named nativesdk too (I've never built an SDK so=
=20
> 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 natives=
dk,
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=20
> 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=20
> https://docs.yoctoproject.org/sdk-manual/appendix-obtain.html#building-an=
-sdk-installer=20
> ?).

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

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

I'll see what could be done

Thanks!
Antonin