ref-manual: Edits to ROOT_HOME

Fixes [YOCTO #5762]

Applied some more detail based on Laszlo's review comments.

(From yocto-docs rev: eb8d11504d6c22dfd9620422df3fc31cfcebb00c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2014-01-31 16:25:55 -06:00 committed by Richard Purdie
parent f084e33e5d
commit f670e3a134
1 changed files with 17 additions and 4 deletions

View File

@ -5480,13 +5480,26 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<literallayout class='monospaced'>
ROOT_HOME ??= "/home/root"
</literallayout>
<note>
This default value is likely used because some
embedded solutions prefer to have a read-only root
filesystem and prefer to keep writeable data in one
place.
</note>
</para>
<para>
You can override the default by setting the variable
in any layer or in the
<filename>local.conf</filename> file using the following
form:
in any layer or in the <filename>local.conf</filename> file.
Because the default is set using a "weak" assignment
(i.e. "??="), you can use either of the following forms
to define your override:
<literallayout class='monospaced'>
ROOT_HOME ?= "&lt;path&gt;"
ROOT_HOME = "/root"
ROOT_HOME ?= "/root"
</literallayout>
These override examples use <filename>/root</filename>,
which is probably the most commonly used override.
</para>
</glossdef>
</glossentry>