Skip to contentSkip to conversation

docs: Sphinx note directive for DISTO_FEATURES definition

PATCH In review Aatir Manzur 2 participants 3 messages Jul 5, 2022 – Jul 18, 2022 1 message not in the archive

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs: Sphinx note directive for DISTO_FEATURES definition

---
 documentation/ref-manual/variables.rst | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)
documentation/ref-manual/variables.rst +8 -4
index c4b2119f2..6a43e8dc5 100644
@@ -1886,10 +1886,14 @@ 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. 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/disable package features.
+      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/disable 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.25.1
Reviewed-by on v1 1/1
#1 lore raw

Hi Aatir,

Sorry for the delay, just had the time to look at it now.

Quoted 10 lines · aatir
---
  documentation/ref-manual/variables.rst | 12 ++++++++----
  1 file changed, 8 insertions(+), 4 deletions(-)
documentation/ref-manual/variables.rst +0 -0
index c4b2119f2..6a43e8dc5 100644

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

Quoted 9 lines
documentation/ref-manual/variables.rst +2 -4
@@ -1886,10 +1886,14 @@ 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. 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/disable package features.
+      enabled.
+

Spurious white space after the dot.

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

Quoted 2 lines
documentation/ref-manual/variables.rst +2 -0
+      .. note::
+

Spurious white space after the second colon.

This looks good otherwise, can be fixed while applying by the maintainer I guess.

Thanks!
Quentin

#3 lore raw
In reply to a message not in the archive

Can someone please tell me where that From: field might be getting picked up from? I can see my full name when I look at my git log. commit caebfc10b69bcb35a4fcf850df2496de5c490b44 (HEAD -> master)

Author: Aatir Manzur <[email protected]>
Date:   Tue Jul 5 15:19:07 2022 -0400

docs: Sphinx note directive for DISTO_FEATURES definition

Quoted 61 lines · Michael Opdenacker
Quoted 31 lines · Quentin Schulz

Hi Aatir,

Sorry for the delay, just had the time to look at it now.

Quoted 18 lines · aatir
---
  documentation/ref-manual/variables.rst | 12 ++++++++----
  1 file changed, 8 insertions(+), 4 deletions(-)
documentation/ref-manual/variables.rst +0 -0
index c4b2119f2..6a43e8dc5 100644
@@ -1886,10 +1886,14 @@ 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. Note: just enabling :term:DISTRO_FEATURES alone
doesn't

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

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

Spurious white space after the dot.

Quoted 7 lines

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

Quoted 2 lines
documentation/ref-manual/variables.rst +2 -0
+      .. note::
+

Spurious white space after the second colon.

This looks good otherwise, can be fixed while applying by the maintainer I guess.

Right, I fixed that, as well as a typo in the commit title. By the way, the commit author was still wrong, because the "From" field of your e-mail was incomplete:

From: "aatir" <[email protected]>
instead of
From: "Aatir Manzur" <[email protected]>

I fixed the commit in master-next, but I hope you can fix it for next time.

Many thanks!
Michael.

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