Skip to contentSkip to conversation

manuals: document INIT_MANAGER

PATCH New [email protected] 1 participant 1 message Apr 17, 2023

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 manuals: document INIT_MANAGER

From: Michael Opdenacker <[email protected]>

- Document the INIT_MANAGER variable and all its
possible settings

- Stop mentioning "rescue image" generation, as this is not detailed anywhere else.

- Expand the "Selecting an Initialization Manager" section.

---
 documentation/dev-manual/device-manager.rst   |   2 +
 documentation/dev-manual/init-manager.rst     | 111 ++++++++++--------
 .../migration-guides/migration-3.0.rst        |   6 +-
 documentation/ref-manual/variables.rst        |  25 ++++
 4 files changed, 95 insertions(+), 49 deletions(-)
documentation/dev-manual/device-manager.rst +2 -0
index 4248c23b44..0343d19b9c 100644
@@ -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 +65 -46

153 lines not on this page · raw message

documentation/migration-guides/migration-3.0.rst +3 -3
index 8e7a58e74d..6a3e3f084d 100644
@@ -13,12 +13,12 @@ Init System Selection
 
 Changing the init system manager previously required setting a number of
 different variables. You can now change the manager by setting the
-``INIT_MANAGER`` variable and the corresponding include files (i.e.
+:term:`INIT_MANAGER` variable and the corresponding include files (i.e.
 ``conf/distro/include/init-manager-*.conf``). Include files are provided
 for four values: "none", "sysvinit", "systemd", and "mdev-busybox". The
-default value, "none", for ``INIT_MANAGER`` should allow your current
+default value, "none", for :term:`INIT_MANAGER` should allow your current
 settings to continue working. However, it is advisable to explicitly set
-``INIT_MANAGER``.
+:term:`INIT_MANAGER`.
 
 .. _migration-3.0-lsb-support-removed:
 
documentation/ref-manual/variables.rst +25 -0
index 62f28bd278..c9a9ba7ba9 100644
@@ -3988,6 +3988,31 @@ system and gives an overview of their function and contents.
          even if the toolchain's binaries are strippable, there are other files
          needed for the build that are not strippable.
 
+   :term:`INIT_MANAGER`
+      This variable allows to choose the init manager for the system. Possible
+      values correspond to the ``init-manager-*.inc`` include files in
+      :yocto_git:`tree/meta/conf/distro/include/ </poky/tree/meta/conf/distro/include>`:
+      ``none``, ``sysvinit``, ``systemd``, and ``mdev-busybox``.
+
+      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 ``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.
+
+      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.
+
+      See the ":ref:`init-manager`" section for further details.
+
    :term:`Initramfs`
       An Initial RAM Filesystem (:term:`Initramfs`) is an optionally compressed
       :wikipedia:`cpio <Cpio>` archive which is extracted
Signature · 1 line
2.34.1