Skip to contentSkip to conversation

docs: make DISTRO_FEATURES description more explicit

PATCH In review Aatir Manzur 2 participants 3 messages Jun 23, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs: make DISTRO_FEATURES description more explicit

Make DISTRO_FEATURES description more explicit by specifying that DISTRO_FEATURES alone can't select build configurations, and need mechanisms like PACKAGECONFIG setup to take care of selecting build configurations.

Signed-off-by Aatir Manzur <[email protected]>

---
 documentation/ref-manual/features.rst  | 4 +++-
 documentation/ref-manual/variables.rst | 5 ++++-
 2 files changed, 7 insertions(+), 2 deletions(-)
documentation/ref-manual/features.rst +3 -1
index a8d0dac99..17521ac2a 100644
@@ -100,7 +100,9 @@ packages, and they can go beyond simply controlling the installation of
 a package or packages. In most cases, the presence or absence of a
 feature translates to the appropriate option supplied to the configure
 script during the :ref:`ref-tasks-configure` task for
-the recipes that optionally support the feature.
+the recipes that optionally support the feature. Appropriate options
+must be supplied, and enabling/disabling :term:`PACKAGECONFIG` for the
+concerned packages is one way of supplying such options.
 
 Some distro features are also machine features. These select features
 make sense to be controlled both at the machine and distribution
documentation/ref-manual/variables.rst +4 -1
index 28267101d..8f7b01c12 100644
@@ -1873,7 +1873,10 @@ system and gives an overview of their function and contents.
       optionally support the feature. For example, specifying "x11" in
       :term:`DISTRO_FEATURES`, causes every piece of software built for the
       target that can optionally support X11 to have its X11 support
-      enabled.
+      enabled. Note: just enabling :term: `DISTRO_FEATURES` alone doesn't
+      enable feature support for packages, mechanisms such as making
+      :term:`PACKAGECONFIG` track :term:`DISTRO_FEATURES` are used
+      to enable/disbale package features.
 
       Two more examples are Bluetooth and NFS support. For a more complete
       list of features that ships with the Yocto Project and that you can
Signature · 1 line
2.31.0
Reviewed-by on v1 1/1
#1 lore raw

Hi Aatir,

Thanks for the update!

Quoted 1 line · aatir

+ enabled. Note: just enabling :term: DISTRO_FEATURES alone doesn't

Oops, you forgot to remove the space here. I fixed that by myself.

documentation/ref-manual/variables.rst system and gives an overview of their function and contents. · line 1879

Quoted 3 lines
documentation/ref-manual/variables.rst +3 -0
+      enable feature support for packages, mechanisms such as making
+      :term:`PACKAGECONFIG` track :term:`DISTRO_FEATURES` are used
+      to enable/disbale package features.

s/disbale/disable/
I fixed that by myself

I leave a little of time for further reviews, but it looks good to me. Thanks again, and don't hesitate to send us more improvements!

Cheers
Michael.

Signature · 3 lines
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
#2 lore raw

Great, thanks!

Quoted 32 lines · Michael Opdenacker

Hi Aatir,

Thanks for the update!

Quoted 1 line · aatir

+ enabled. Note: just enabling :term: DISTRO_FEATURES alone

doesn't

Oops, you forgot to remove the space here. I fixed that by myself.

documentation/ref-manual/variables.rst system and gives an overview of their function and contents. · line 1879

Quoted 3 lines
documentation/ref-manual/variables.rst +3 -0
+      enable feature support for packages, mechanisms such as making
+      :term:`PACKAGECONFIG` track :term:`DISTRO_FEATURES` are used
+      to enable/disbale package features.

s/disbale/disable/
I fixed that by myself

I leave a little of time for further reviews, but it looks good to me. Thanks again, and don't hesitate to send us more improvements!

Cheers
Michael.

--
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com