docs: Replace VOLATILE_LOG_DIR with FILESYSTEM_PERMS_TABLES

The VOLATILE_LOG_DIR variable was removed and it's functionality
replaced with a FILESYSTEM_PERMS_TABLES entry in
https://git.yoctoproject.org/poky/commit/?id=2f8806deb7655b37d6f8d12ff54680d6acf7a298
("bitbake.conf: drop VOLATILE_LOG_DIR, use FILESYSTEM_PERMS_TABLES instead")

(From yocto-docs rev: 8632cd1070da26f217046071c43dd2f877f2e608)

Signed-off-by: Niko Mauno <niko.mauno@vaisala.com>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit b1c22561878ba618eb69e4c8784ea346b989a0ea)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>

documentation/migration-guides/migration-5.1.rst

@@ -142,6 +142,12 @@ The following variables have been removed:
 -  ``TCLIBCAPPEND`` is now removed as sharing :term:`TMPDIR` for multiple libc
    providers has been supported for years.
 
+-  ``VOLATILE_LOG_DIR``: :term:`FILESYSTEM_PERMS_TABLES` is now used instead.
+   By default, :term:`FILESYSTEM_PERMS_TABLES` now contains the value
+   ``files/fs-perms-volatile-log.txt``, which means that volatile log is
+   enabled. Users can disable the volatile log by removing the value
+   ``files/fs-perms-volatile-log.txt`` from :term:`FILESYSTEM_PERMS_TABLES`.
+
 .. _migration-5.1-removed-recipes:
 
 Removed recipes

documentation/ref-manual/features.rst

@@ -327,8 +327,9 @@ The image features available for all images are:
 
    .. note::
 
-      To make the ``/var/log`` directory on the target persistent, use the
+      To make the ``/var/log`` directory on the target persistent, remove the
-      :term:`VOLATILE_LOG_DIR` variable by setting it to "no".
+      ``files/fs-perms-volatile-log.txt`` value from
+      :term:`FILESYSTEM_PERMS_TABLES`.
 
 -  *ptest-pkgs:* Installs ptest packages for all ptest-enabled recipes.
 

documentation/ref-manual/variables.rst

@@ -13,7 +13,7 @@ system and gives an overview of their function and contents.
 :term:`K <KARCH>` :term:`L <LABELS>` :term:`M <MACHINE>`
 :term:`N <NATIVELSBSTRING>` :term:`O <OBJCOPY>` :term:`P`
 :term:`R <RANLIB>` :term:`S` :term:`T`
-:term:`U <UBOOT_CONFIG>` :term:`V <VOLATILE_LOG_DIR>`
+:term:`U <UBOOT_CONFIG>` :term:`V <VIRTUAL-RUNTIME>`
 :term:`W <WARN_QA>` :term:`X <XSERVER>`
 
 .. glossary::
@@ -3007,26 +3007,30 @@ system and gives an overview of their function and contents.
       :ref:`ref-tasks-patch` task as well.
 
    :term:`FILESYSTEM_PERMS_TABLES`
-      Allows you to define your own file permissions settings table as part
+      Allows you to define your own file permissions settings tables as part
       of your configuration for the packaging process. For example, suppose
       you need a consistent set of custom permissions for a set of groups
       and users across an entire work project. It is best to do this in the
       packages themselves but this is not always possible.
 
-      By default, the OpenEmbedded build system uses the ``fs-perms.txt``,
+      By default, the OpenEmbedded build system uses the ``fs-perms.txt`` and
-      which is located in the ``meta/files`` folder in the :term:`Source Directory`.
+      ``fs-perms-volatile-log.txt`` which are located in the ``meta/files``
-      If you create your own file
+      folder in the :term:`Source Directory`. If you create your own permission
-      permissions setting table, you should place it in your layer or the
+      setting table files, you should place those in your layer.
-      distro's layer.
 
-      You define the :term:`FILESYSTEM_PERMS_TABLES` variable in the
+      You can override the value of :term:`FILESYSTEM_PERMS_TABLES` variable
-      ``conf/local.conf`` file, which is found in the :term:`Build Directory`,
+      in your distribution configuration file to point to your custom
-      to point to your custom ``fs-perms.txt``. You can specify more than a
+      permission table files. You can specify one or more file permissions
-      single file permissions setting table. The paths you specify to these
+      setting tables. The paths that you specify to these files must be defined
-      files must be defined within the :term:`BBPATH` variable.
+      within the :term:`BBPATH` variable.
 
-      For guidance on how to create your own file permissions settings
+      In order to disable the volatile log, which is enabled by default, one
-      table file, examine the existing ``fs-perms.txt``.
+      can remove the ``files/fs-perms-volatile-log.txt`` value from
+      ``FILESYSTEM_PERMS_TABLES``.
+
+      For guidance on how to define your own file permissions settings
+      tables, examine the existing ``fs-perms.txt`` and
+      ``fs-perms-volatile-log.txt`` files.
 
    :term:`FIT_ADDRESS_CELLS`
       Specifies the value of the ``#address-cells`` value for the
@@ -10075,14 +10079,6 @@ system and gives an overview of their function and contents.
 
          PACKAGE_INSTALL = "${INITRAMFS_SCRIPTS} ${VIRTUAL-RUNTIME_base-utils} base-passwd"
 
-   :term:`VOLATILE_LOG_DIR`
-      Specifies the persistence of the target's ``/var/log`` directory,
-      which is used to house postinstall target log files.
-
-      By default, :term:`VOLATILE_LOG_DIR` is set to "yes", which means the
-      file is not persistent. You can override this setting by setting the
-      variable to "no" to make the log directory persistent.
-
    :term:`VOLATILE_TMP_DIR`
       Specifies the persistence of the target's ``/tmp`` directory.