[PATCH 32/34] ref-manual: add overlayfs class variables

Paul Eggleton
2022-10-10T09:24:43Z

The overlayfs class was added in the honister release.

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
---
documentation/ref-manual/variables.rst | 24 ++++++++++++++++++++++++
1 file changed, 24 insertions(+)

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index a14288e..00d51e5 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -5273,6 +5273,30 @@ system and gives an overview of their function and contents.
information, see the :ref:`overlayfs-etc <ref-classes-overlayfs-etc>`
class documentation. The default value is "1".

+ :term:`OVERLAYFS_MOUNT_POINT`
+ When inheriting the :ref:`overlayfs <ref-classes-overlayfs>` class,
+ specifies mount point(s) to be used. For example::
+
+ OVERLAYFS_MOUNT_POINT[data] = "/data"
+
+ The assumes you have a ``data.mount`` systemd unit defined elsewhere
+ in your BSP (e.g. in ``systemd-machine-units`` recipe) and it is
+ installed into the image. For more information see
+ :ref:`overlayfs <ref-classes-overlayfs>`.
+
+ .. note::
+
+ Although the :ref:`overlayfs <ref-classes-overlayfs>` class is
+ inherited by individual recipes, :term:`OVERLAYFS_MOUNT_POINT`
+ should be set in your machine configuration.
+
+ :term:`OVERLAYFS_WRITABLE_PATHS`
+ When inheriting the :ref:`overlayfs <ref-classes-overlayfs>` class,
+ specifies writable paths used at runtime for the recipe. For
+ example::
+
+ OVERLAYFS_WRITABLE_PATHS[data] = "/usr/share/my-custom-application"
+
:term:`OVERRIDES`
A colon-separated list of overrides that currently apply. Overrides
are a BitBake mechanism that allows variables to be selectively
--
1.8.3.1