diff mbox series

[10/20] ref-manual/features.rst: add section for SDK features

Message ID 20260918-releases-notes-6-1-v1-10-2d0fceffa242@bootlin.com
State New
Headers show
Series Updates and release notes for 6.1 | expand

Commit Message

Antonin Godard Sept. 18, 2026, 1:53 p.m. UTC
The SDK_FEATURES variable can contain features to enable for the
generated standard/extensible SDK. Document them and document the
SDK_FEATURES variable.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/ref-manual/features.rst  | 21 +++++++++++++++++++++
 documentation/ref-manual/variables.rst | 10 ++++++++++
 2 files changed, 31 insertions(+)
diff mbox series

Patch

diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst
index 879d98ca1..89143344a 100644
--- a/documentation/ref-manual/features.rst
+++ b/documentation/ref-manual/features.rst
@@ -423,6 +423,27 @@  these valid features is as follows:
 
 -  *x11-sato:* Installs the OpenedHand Sato environment.
 
+
+.. _ref-features-sdk:
+
+SDK Features
+============
+
+The contents of a :ref:`standard <sdk-manual/using:Using the Standard SDK>` or
+:ref:`extensible <sdk-manual/extensible:Using the extensible SDK>` SDK generated by
+the :term:`OpenEmbedded Build System` can be controlled by the
+:term:`SDK_FEATURES` variable that you typically configure in the image recipe
+for which the :ref:`ref-tasks-populate_sdk` or :ref:`ref-tasks-populate_sdk_ext`
+task is run.
+
+The SDK features available are:
+
+-  ``go``: add `Go` utilities for building `Go`-based applications.
+
+-  ``kernel-src``: adds the Linux kernel source tree to the SDK.
+
+-  ``rust``: add `Rust` utilities for building `Rust`-based applications.
+
 Default Features
 ================
 
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 2b2aa4df8..880bf9069 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -8992,6 +8992,16 @@  system and gives an overview of their function and contents.
          :term:`SSTATE_MIRRORS` is set in the SDK's configuration to enable the
          artifacts to be fetched as needed.
 
+   :term:`SDK_FEATURES`
+      The :term:`SDK_FEATURES` variable defines the list of features to include
+      in a :ref:`standard SDK <sdk-manual/using:Using the Standard SDK>` or
+      :ref:`extensible SDK <sdk-manual/extensible:Using the extensible SDK>`,
+      resolved when running the :ref:`ref-tasks-populate_sdk` or
+      :ref:`ref-tasks-populate_sdk_ext` task. This variable is analogous to
+      :term:`IMAGE_FEATURES`, but for the SDK instead of the image.
+
+      For a full list of features, see the :ref:`ref-features-sdk` section.
+
    :term:`SDK_HOST_MANIFEST`
       The manifest file for the host part of the SDK. This file lists all
       the installed packages that make up the host part of the SDK. The