summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPaul Eggleton <bluelightning@bluelightning.org>2023-04-22 15:19:50 +1200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2023-04-22 10:42:54 +0100
commit7508711b3835cc7890d46fda1b4a1c3da196ec9a (patch)
tree66ddb92359383f5ca180f1e6c89cddc256a76e43
parent5a8e2d41a63b7af94da85aa7a6fd6393582f84c3 (diff)
downloadpoky-7508711b3835cc7890d46fda1b4a1c3da196ec9a.tar.gz
dev/ref-manual: Document INIT_MANAGER
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. (From yocto-docs rev: 602c0e8f770516256dab04edfd887377303c06bb) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/dev-manual/init-manager.rst24
-rw-r--r--documentation/ref-manual/variables.rst15
2 files changed, 21 insertions, 18 deletions
diff --git a/documentation/dev-manual/init-manager.rst b/documentation/dev-manual/init-manager.rst
index 0617fed516..10c4754e62 100644
--- a/documentation/dev-manual/init-manager.rst
+++ b/documentation/dev-manual/init-manager.rst
@@ -38,26 +38,14 @@ following sections.
38Using systemd Exclusively 38Using systemd Exclusively
39========================= 39=========================
40 40
41Set these variables in your distribution configuration file as follows:: 41Set the :term:`INIT_MANAGER` variable in your distribution configuration
42 42file as follows::
43 DISTRO_FEATURES:append = " systemd"
44 VIRTUAL-RUNTIME_init_manager = "systemd"
45
46You can also prevent the SysVinit distribution feature from
47being automatically enabled as follows::
48
49 DISTRO_FEATURES_BACKFILL_CONSIDERED = "sysvinit"
50
51Doing so removes any
52redundant SysVinit scripts.
53
54To remove initscripts from your image altogether, set this variable
55also::
56 43
57 VIRTUAL-RUNTIME_initscripts = "" 44 INIT_MANAGER = "systemd"
58 45
59For information on the backfill variable, see 46This will enable systemd and remove sysvinit components from the image.
60:term:`DISTRO_FEATURES_BACKFILL_CONSIDERED`. 47See ``meta/conf/distro/include/init-manager-systemd.inc`` for exact
48details on what this does.
61 49
62Using systemd for the Main Image and Using SysVinit for the Rescue Image 50Using systemd for the Main Image and Using SysVinit for the Rescue Image
63======================================================================== 51========================================================================
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index bfdf1d1401..79d56dd704 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.
3956 even if the toolchain's binaries are strippable, there are other files 3956 even if the toolchain's binaries are strippable, there are other files
3957 needed for the build that are not strippable. 3957 needed for the build that are not strippable.
3958 3958
3959 :term:`INIT_MANAGER`
3960 Specifies the system init manager to use. Available options are:
3961
3962 - ``sysvinit`` - System V init (default for poky)
3963 - ``systemd`` - systemd
3964 - ``mdev-busybox`` - mdev provided by busybox
3965 - ``none`` - no init manager
3966
3967 More concretely, this is used to include
3968 ``conf/distro/include/init-manager-${INIT_MANAGER}.inc`` into the global
3969 configuration. You can have a look at the ``conf/distro/include/init-manager-*.inc``
3970 files for more information, and also the
3971 ":ref:`dev-manual/init-manager:selecting an initialization manager`"
3972 section in the Yocto Project Development Tasks Manual.
3973
3959 :term:`INITRAMFS_DEPLOY_DIR_IMAGE` 3974 :term:`INITRAMFS_DEPLOY_DIR_IMAGE`
3960 Indicates the deploy directory used by :ref:`ref-tasks-bundle_initramfs` 3975 Indicates the deploy directory used by :ref:`ref-tasks-bundle_initramfs`
3961 where the :term:`INITRAMFS_IMAGE` will be fetched from. This variable is 3976 where the :term:`INITRAMFS_IMAGE` will be fetched from. This variable is