[PATCH] docs: Sphinx note directive for DISTO_FEATURES definition

[PATCH] docs: Sphinx note directive for DISTO_FEATURES definition

[Aatir Manzur]

Signed-off-by: Aatir Manzur <aatrapps@gmail.com>
---
 documentation/ref-manual/variables.rst | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index c4b2119f2..6a43e8dc5 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -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
-- 
2.25.1

Re: [docs] [PATCH] docs: Sphinx note directive for DISTO_FEATURES definition

[Quentin Schulz]

Hi Aatir,

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

On 7/5/22 21:38, aatir wrote:
> Signed-off-by: Aatir Manzur <aatrapps@gmail.com>
> ---
>   documentation/ref-manual/variables.rst | 12 ++++++++----
>   1 file changed, 8 insertions(+), 4 deletions(-)
> 
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index c4b2119f2..6a43e8dc5 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -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.

> +      .. note::
> +

Spurious white space after the second colon.

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

Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>

Thanks!
Quentin

Re: [docs] [PATCH] docs: Sphinx note directive for DISTO_FEATURES definition

[Aatir Manzur]

[-- Attachment #1: Type: text/plain, Size: 2429 bytes --]

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 <aatrapps@gmail.com>
Date:   Tue Jul 5 15:19:07 2022 -0400

    docs: Sphinx note directive for DISTO_FEATURES definition

    Signed-off-by: Aatir Manzur <aatrapps@gmail.com>

On Mon, Jul 18, 2022 at 7:02 AM Michael Opdenacker <
michael.opdenacker@bootlin.com> wrote:

>
> On 7/18/22 11:06, Quentin Schulz wrote:
> > Hi Aatir,
> >
> > Sorry for the delay, just had the time to look at it now.
> >
> > On 7/5/22 21:38, aatir wrote:
> >> Signed-off-by: Aatir Manzur <aatrapps@gmail.com>
> >> ---
> >>   documentation/ref-manual/variables.rst | 12 ++++++++----
> >>   1 file changed, 8 insertions(+), 4 deletions(-)
> >>
> >> diff --git a/documentation/ref-manual/variables.rst
> >> b/documentation/ref-manual/variables.rst
> >> index c4b2119f2..6a43e8dc5 100644
> >> --- a/documentation/ref-manual/variables.rst
> >> +++ b/documentation/ref-manual/variables.rst
> >> @@ -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.
> >
> >> +      .. 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" <aatrapps@gmail.com>
> instead of
> From: "Aatir Manzur" <aatrapps@gmail.com>
>
> 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
>
>

[-- Attachment #2: Type: text/html, Size: 3588 bytes --]