diff mbox series

[14/17] Document INIT_MANAGER

Message ID 4283cb7fbe25a6d54df2b3359a1e46f9bc4d708c.1682133339.git.bluelightning@bluelightning.org
State New
Headers show
Series [01/17] ref-manual: add new SDK_ZIP_OPTIONS variable | expand

Commit Message

Paul Eggleton April 22, 2023, 3:19 a.m. UTC
The INIT_MANAGER variable was added in 3.0 but it seems we didn't get
around to documenting it yet. I have added a variable glossary entry and
made the basic adjustment of the "Using systemd Exclusively" section in
the dev manual, however I think the latter section still needs work.

Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
 documentation/dev-manual/init-manager.rst | 24 ++++++-----------------
 documentation/ref-manual/variables.rst    | 15 ++++++++++++++
 2 files changed, 21 insertions(+), 18 deletions(-)
diff mbox series


diff --git a/documentation/dev-manual/init-manager.rst b/documentation/dev-manual/init-manager.rst
index 0617fed5166..10c4754e626 100644
--- a/documentation/dev-manual/init-manager.rst
+++ b/documentation/dev-manual/init-manager.rst
@@ -38,26 +38,14 @@  following sections.
 Using systemd Exclusively
-Set these variables in your distribution configuration file as follows::
-   DISTRO_FEATURES:append = " systemd"
-   VIRTUAL-RUNTIME_init_manager = "systemd"
-You can also prevent the SysVinit distribution feature from
-being automatically enabled as follows::
-Doing so removes any
-redundant SysVinit scripts.
-To remove initscripts from your image altogether, set this variable
+Set the :term:`INIT_MANAGER` variable in your distribution configuration
+file as follows::
-   VIRTUAL-RUNTIME_initscripts = ""
+   INIT_MANAGER = "systemd"
-For information on the backfill variable, see
+This will enable systemd and remove sysvinit components from the image.
+See ``meta/conf/distro/include/init-manager-systemd.inc`` for exact
+details on what this does.
 Using systemd for the Main Image and Using SysVinit for the Rescue Image
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index bfdf1d1401a..79d56dd7047 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -3956,6 +3956,21 @@  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`
+      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
+      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`"
+      section in the Yocto Project Development Tasks Manual.
       Indicates the deploy directory used by :ref:`ref-tasks-bundle_initramfs`
       where the :term:`INITRAMFS_IMAGE` will be fetched from. This variable is