Skip to contentSkip to conversation

ref-manual/variables.rst: update ROOT_HOME documentation

PATCH Applied Enrico Jörns 3 participants 3 messages Apr 29, 2025 – May 21, 2025

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 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")

---
 documentation/ref-manual/variables.rst | 11 +++--------
 1 file changed, 3 insertions(+), 8 deletions(-)
documentation/ref-manual/variables.rst +3 -8
index d17f81036..4527d15e4 100644
@@ -7761,17 +7761,12 @@ system and gives an overview of their function and contents.
          prefer to have a read-only root filesystem and prefer to keep
          writeable data in one place.
 
-      You can override the default by setting the variable in any layer or
-      in the ``local.conf`` file. Because the default is set using a "weak"
-      assignment (i.e. "??="), you can use either of the following forms to
-      define your override::
+      When setting ``INIT_MANAGER = systemd``, the default will be set to::
 
-         ROOT_HOME = "/root"
          ROOT_HOME ?= "/root"
 
-      These
-      override examples use ``/root``, which is probably the most commonly
-      used override.
+      You can also override the default by setting the variable in your distro
+      configuration or in the ``local.conf`` file.
 
    :term:`ROOTFS`
       Indicates a filesystem image to include as the root filesystem.
Signature · 1 line
2.39.5
Reviewed-by on v1 1/1
#1 lore raw

Hi Enrico,

Quoted 9 lines · Enrico Jörns via lists.yoctoproject.org

* 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.

Quoted 3 lines

[1] ebafe463 ("systemd: upgrade to 255.1")

Thanks!
Quentin

#2 lore raw
In reply to Enrico Jörns
Quoted 10 lines · Enrico Jörns

* 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.

[...]

Applied, thanks!

[1/1] ref-manual/variables.rst: update ROOT_HOME documentation

      commit: 50e92009d309fc4ae406174feb8f6578142748cc

Best regards,

Signature · 1 line
Antonin Godard <[email protected]>