From 01372ac01cfd8d886220f1ef23c8eb798a33b6de Mon Sep 17 00:00:00 2001 From: Paul Eggleton Date: Mon, 10 Oct 2022 14:50:21 +1300 Subject: ref-manual: add overlayfs class variables The overlayfs class was added in the honister release. (From yocto-docs rev: cff6b5a167d8f7d99a351c7989bc86af5e553552) Signed-off-by: Paul Eggleton Signed-off-by: Richard Purdie --- documentation/ref-manual/variables.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) (limited to 'documentation/ref-manual') diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 0f8924188f..ff9eb51e8f 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -5231,6 +5231,30 @@ system and gives an overview of their function and contents. information, see the :ref:`overlayfs-etc ` class documentation. The default value is "1". + :term:`OVERLAYFS_MOUNT_POINT` + When inheriting the :ref:`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 `. + + .. note:: + + Although the :ref:`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 ` 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 -- cgit v1.2.3-54-g00ecf