diff mbox series

ref-manual: variables.rst: don't mention the INIT_MANAGER "none" option

Message ID 20230502144906.2449915-1-michael.opdenacker@bootlin.com
State New
Headers show
Series ref-manual: variables.rst: don't mention the INIT_MANAGER "none" option | expand

Commit Message

Michael Opdenacker May 2, 2023, 2:49 p.m. UTC
From: Michael Opdenacker <michael.opdenacker@bootlin.com>

As it is mainly used for internal purposes, so not necessarily useful
for regular users.

OE-core "nodistro" uses it as a fallback to the default setting.

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 documentation/ref-manual/variables.rst | 5 -----
 1 file changed, 5 deletions(-)

Comments

Alexander Kanavin May 2, 2023, 2:55 p.m. UTC | #1
I so t think having an undocumented option is a better choice than making
it do what it says. We can fix nodistro to use something else for the
fallback.


Alex

On Tue 2. May 2023 at 16.49, Michael Opdenacker via lists.yoctoproject.org
<michael.opdenacker=bootlin.com@lists.yoctoproject.org> wrote:

> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
>
> As it is mainly used for internal purposes, so not necessarily useful
> for regular users.
>
> OE-core "nodistro" uses it as a fallback to the default setting.
>
> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> CC: Richard Purdie <richard.purdie@linuxfoundation.org>
> ---
>  documentation/ref-manual/variables.rst | 5 -----
>  1 file changed, 5 deletions(-)
>
> diff --git a/documentation/ref-manual/variables.rst
> b/documentation/ref-manual/variables.rst
> index 4dc67a1324..574af2c2f9 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -3962,7 +3962,6 @@ system and gives an overview of their function and
> contents.
>        -  ``sysvinit``
>        -  ``systemd``
>        -  ``mdev-busybox``
> -      -  ``none``
>
>        With ``sysvinit``, the init manager is set to
>        :wikipedia:`SysVinit <Init#SysV-style>`, the traditional UNIX init
> @@ -3977,10 +3976,6 @@ system and gives an overview of their function and
> contents.
>        and lightest solution, and probably the best choice for low-end
> systems
>        with a rather slow CPU and a limited amount of RAM.
>
> -      With ``none``, the init manager is also set to ``sysvinit``. This
> is the
> -      default setting in OpenEmbedded-Core. This option also selects the
> -      :wikipedia:`udev <Udev>` device manager.
> -
>        More concretely, this is used to include
>        ``conf/distro/include/init-manager-${INIT_MANAGER}.inc`` into the
> global
>        configuration. You can have a look at the
> --
> 2.34.1
>
>
> -=-=-=-=-=-=-=-=-=-=-=-
> Links: You receive all messages sent to this group.
> View/Reply Online (#3890):
> https://lists.yoctoproject.org/g/docs/message/3890
> Mute This Topic: https://lists.yoctoproject.org/mt/98640319/1686489
> Group Owner: docs+owner@lists.yoctoproject.org
> Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [
> alex.kanavin@gmail.com]
> -=-=-=-=-=-=-=-=-=-=-=-
>
>
Richard Purdie May 2, 2023, 3 p.m. UTC | #2
On Tue, 2023-05-02 at 16:55 +0200, Alexander Kanavin wrote:
> I so t think having an undocumented option is a better choice than
> making it do what it says. We can fix nodistro to use something else
> for the fallback.

It does actually do what it says, it is just that people have
misinterpreted what "none" means.

"none" in this context means no value was set, which means to fall back
to the behaviour that we had before the INIT_MANAGER existed.

It doesn't mean "there is no init manager".

I agree it is ambiguous so perhaps we should rename it :/

Cheers,

Richard
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 4dc67a1324..574af2c2f9 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -3962,7 +3962,6 @@  system and gives an overview of their function and contents.
       -  ``sysvinit``
       -  ``systemd``
       -  ``mdev-busybox``
-      -  ``none``
 
       With ``sysvinit``, the init manager is set to
       :wikipedia:`SysVinit <Init#SysV-style>`, the traditional UNIX init
@@ -3977,10 +3976,6 @@  system and gives an overview of their function and contents.
       and lightest solution, and probably the best choice for low-end systems
       with a rather slow CPU and a limited amount of RAM.
 
-      With ``none``, the init manager is also set to ``sysvinit``. This is the
-      default setting in OpenEmbedded-Core. This option also selects the
-      :wikipedia:`udev <Udev>` device manager.
-
       More concretely, this is used to include
       ``conf/distro/include/init-manager-${INIT_MANAGER}.inc`` into the global
       configuration. You can have a look at the