manuals: expand init manager documentation
PATCH 1/1 manuals: expand init manager documentation
From: Michael Opdenacker <[email protected]>
- Add details about INIT_MANAGER
Correct the fact that "none" currently generates an image with "sysvinit", at least on Poky. This behaviour should probably be changed.
- Expand the "Selecting an Initialization Manager" section.
- Stop mentioning "rescue image" generation, as this is not detailed anywhere else.
--- documentation/dev-manual/device-manager.rst | 2 + documentation/dev-manual/init-manager.rst | 108 +++++++++++++------- documentation/ref-manual/variables.rst | 31 ++++-- 3 files changed, 98 insertions(+), 43 deletions(-)
documentation/dev-manual/device-manager.rst +2 -0
@@ -1,5 +1,7 @@ .. SPDX-License-Identifier: CC-BY-SA-2.0-UK +.. _device-manager: + Selecting a Device Manager **************************
documentation/dev-manual/init-manager.rst +72 -36
148 lines not on this page · raw message
documentation/ref-manual/variables.rst +24 -7
@@ -3959,16 +3959,33 @@ system and gives an overview of their function and contents. :term:`INIT_MANAGER` Specifies the system init manager to use. Available options are: - - ``sysvinit`` - System V init (default for poky) - - ``systemd`` - systemd - - ``mdev-busybox`` - mdev provided by busybox - - ``none`` - no init manager + - ``sysvinit`` + - ``systemd`` + - ``mdev-busybox`` + - ``none`` + + With ``sysvinit``, the init manager is set to + :wikipedia:`SysVinit <Init#SysV-style>`, the traditional UNIX init + system. This is the default choice in the Poky distribution, together with + the Udev device manager (see the ":ref:`device-manager`" section). + + With ``systemd``, the init manager becomes :wikipedia:`systemd <Systemd>`, + which comes with the :wikipedia:`udev <Udev>` device manager. + + With ``mdev-busybox``, the init manager becomes the must simpler BusyBox + init, together with the BusyBox mdev device manager. This is the simplest + 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 ``conf/distro/include/init-manager-*.inc`` - files for more information, and also the - ":ref:`dev-manual/init-manager:selecting an initialization manager`" + configuration. You can have a look at the + :yocto_git:`meta/conf/distro/include/init-manager-*.inc </poky/tree/meta/conf/distro/include>` + files for more information, and also the ":ref:`init-manager`" section in the Yocto Project Development Tasks Manual. :term:`INITRAMFS_DEPLOY_DIR_IMAGE`
Signature · 1 line
2.34.1
Hi Michael,
Quoted 20 lines · Michael Opdenacker via lists.yoctoproject.org
From: Michael Opdenacker <[email protected]>
- Add details about
INIT_MANAGER
Correct the fact that "none" currently generates an image with "sysvinit", at least on Poky. This behaviour should probably be changed.- Expand the "Selecting an Initialization Manager" section.
- Stop mentioning "rescue image" generation, as this is not detailed anywhere else.
Signed-off-by Michael Opdenacker <[email protected]>CC Paul Eggleton <[email protected]>--- documentation/dev-manual/device-manager.rst | 2 + documentation/dev-manual/init-manager.rst | 108 +++++++++++++------- documentation/ref-manual/variables.rst | 31 ++++-- 3 files changed, 98 insertions(+), 43 deletions(-)
[...]
Quoted 17 lines
documentation/ref-manual/variables.rst +4
-4@@ -3959,16 +3959,33 @@ system and gives an overview of their function and contents. :term:`INIT_MANAGER` Specifies the system init manager to use. Available options are: - - ``sysvinit`` - System V init (default for poky) - - ``systemd`` - systemd - - ``mdev-busybox`` - mdev provided by busybox - - ``none`` - no init manager + - ``sysvinit`` + - ``systemd`` + - ``mdev-busybox`` + - ``none``
documentation/ref-manual/variables.rst system and gives an overview of their function and contents. · line 3975
Quoted 10 lines
documentation/ref-manual/variables.rst +10
-0+ + With ``sysvinit``, the init manager is set to + :wikipedia:`SysVinit <Init#SysV-style>`, the traditional UNIX init + system. This is the default choice in the Poky distribution, together with + the Udev device manager (see the ":ref:`device-manager`" section). + + With ``systemd``, the init manager becomes :wikipedia:`systemd <Systemd>`, + which comes with the :wikipedia:`udev <Udev>` device manager. + + With ``mdev-busybox``, the init manager becomes the must simpler BusyBox
here a typo probably slipped in:
s/becomes the must simpler/becomes the much simpler/
Quoted 9 lines
documentation/ref-manual/variables.rst +7
-0+ init, together with the BusyBox mdev device manager. This is the simplest + 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
documentation/ref-manual/variables.rst system and gives an overview of their function and contents. · line 3991
Quoted 10 lines
documentation/ref-manual/variables.rst +3
-3``conf/distro/include/init-manager-${INIT_MANAGER}.inc`` into the global - configuration. You can have a look at the ``conf/distro/include/init-manager-*.inc`` - files for more information, and also the - ":ref:`dev-manual/init-manager:selecting an initialization manager`" + configuration. You can have a look at the + :yocto_git:`meta/conf/distro/include/init-manager-*.inc </poky/tree/meta/conf/distro/include>` + files for more information, and also the ":ref:`init-manager`" section in the Yocto Project Development Tasks Manual. :term:`INITRAMFS_DEPLOY_DIR_IMAGE`
A nice refinement for the documentation - thanks!
Best regards
Ulrich
Signature · 4 lines
Pengutronix e.K. | Ulrich Ölmann | Industrial Linux Solutions | http://www.pengutronix.de/ | Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0 | Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 |
Hi Ulrich,
Many thanks for the review!
Quoted 3 lines · Ulrich Ölmann
here a typo probably slipped in:
s/becomes the must simpler/becomes the much simpler/
Good catch. Fixed.
Thanks again!
Michael.
Signature · 3 lines
Michael Opdenacker, Bootlin Embedded Linux and Kernel engineering https://bootlin.com