summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorEnrico Jörns <ejo@pengutronix.de>2025-04-29 20:12:55 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2025-05-19 15:54:10 +0100
commit512d81b697ed36e74cc2d4b8749dd705c2bbf000 (patch)
treed8c51f9c0ed4b5d2a04fefc2adb5b880278f8a77 /documentation/ref-manual
parent15f6f8d67e5f071384046232fcc6855900f08c74 (diff)
downloadpoky-512d81b697ed36e74cc2d4b8749dd705c2bbf000.tar.gz
ref-manual/variables.rst: update ROOT_HOME documentation
* Since scarthgap [1], the default will be overridden when using 'systemd' as INIT_MANAGER. Reflect this in the documentation. * The distro configuration is probably the better place for customization, thus at least mention this together with the local.conf. * While at it, drop the probably redundant description on how to override weak default variables. The example on how to set "/root" is still given indirectly, anyway. [1] ebafe463 ("systemd: upgrade to 255.1") (From yocto-docs rev: 50e92009d309fc4ae406174feb8f6578142748cc) Signed-off-by: Enrico Jörns <ejo@pengutronix.de> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/variables.rst11
1 files changed, 3 insertions, 8 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index c22abd4a8e..295035c760 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -7761,17 +7761,12 @@ system and gives an overview of their function and contents.
7761 prefer to have a read-only root filesystem and prefer to keep 7761 prefer to have a read-only root filesystem and prefer to keep
7762 writeable data in one place. 7762 writeable data in one place.
7763 7763
7764 You can override the default by setting the variable in any layer or 7764 When setting ``INIT_MANAGER = systemd``, the default will be set to::
7765 in the ``local.conf`` file. Because the default is set using a "weak"
7766 assignment (i.e. "??="), you can use either of the following forms to
7767 define your override::
7768 7765
7769 ROOT_HOME = "/root"
7770 ROOT_HOME ?= "/root" 7766 ROOT_HOME ?= "/root"
7771 7767
7772 These 7768 You can also override the default by setting the variable in your distro
7773 override examples use ``/root``, which is probably the most commonly 7769 configuration or in the ``local.conf`` file.
7774 used override.
7775 7770
7776 :term:`ROOTFS` 7771 :term:`ROOTFS`
7777 Indicates a filesystem image to include as the root filesystem. 7772 Indicates a filesystem image to include as the root filesystem.