diff options
author | Enrico Jörns <ejo@pengutronix.de> | 2025-04-29 20:12:55 +0200 |
---|---|---|
committer | Steve Sakoman <steve@sakoman.com> | 2025-05-19 08:32:49 -0700 |
commit | 9ca35cf808836ed42224f15b8785136b205c5332 (patch) | |
tree | 01c84cb9cce36ad2d861b01af00f29f32958d1eb | |
parent | cd1cf857306fb73c7c1394b20161c17a40fd94bf (diff) | |
download | poky-9ca35cf808836ed42224f15b8785136b205c5332.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: f1f92f0a5a881c45ffecf9cf9bd070c992aff35a)
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>
(cherry picked from commit 50e92009d309fc4ae406174feb8f6578142748cc)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
-rw-r--r-- | documentation/ref-manual/variables.rst | 11 |
1 files changed, 3 insertions, 8 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index c637549db8..7064ab8f6c 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -7385,17 +7385,12 @@ system and gives an overview of their function and contents. | |||
7385 | prefer to have a read-only root filesystem and prefer to keep | 7385 | prefer to have a read-only root filesystem and prefer to keep |
7386 | writeable data in one place. | 7386 | writeable data in one place. |
7387 | 7387 | ||
7388 | You can override the default by setting the variable in any layer or | 7388 | When setting ``INIT_MANAGER = systemd``, the default will be set to:: |
7389 | in the ``local.conf`` file. Because the default is set using a "weak" | ||
7390 | assignment (i.e. "??="), you can use either of the following forms to | ||
7391 | define your override:: | ||
7392 | 7389 | ||
7393 | ROOT_HOME = "/root" | ||
7394 | ROOT_HOME ?= "/root" | 7390 | ROOT_HOME ?= "/root" |
7395 | 7391 | ||
7396 | These | 7392 | You can also override the default by setting the variable in your distro |
7397 | override examples use ``/root``, which is probably the most commonly | 7393 | configuration or in the ``local.conf`` file. |
7398 | used override. | ||
7399 | 7394 | ||
7400 | :term:`ROOTFS` | 7395 | :term:`ROOTFS` |
7401 | Indicates a filesystem image to include as the root filesystem. | 7396 | Indicates a filesystem image to include as the root filesystem. |