From 61b6825c5f3be3ebd8bfc38dbff646db3a0773a1 Mon Sep 17 00:00:00 2001 From: Niko Mauno Date: Wed, 16 Oct 2024 14:09:39 +0000 Subject: 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 Reviewed-by: Quentin Schulz Signed-off-by: Antonin Godard Reviewed-by: Antonin Godard (cherry picked from commit b1c22561878ba618eb69e4c8784ea346b989a0ea) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman --- documentation/migration-guides/migration-5.1.rst | 6 ++++ documentation/ref-manual/features.rst | 5 +-- documentation/ref-manual/variables.rst | 40 +++++++++++------------- 3 files changed, 27 insertions(+), 24 deletions(-) (limited to 'documentation') diff --git a/documentation/migration-guides/migration-5.1.rst b/documentation/migration-guides/migration-5.1.rst index 9d8f4b3c6d..18b445c6b5 100644 --- a/documentation/migration-guides/migration-5.1.rst +++ b/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 diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst index b2ba731bb2..6e52dfce17 100644 --- a/documentation/ref-manual/features.rst +++ b/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 - :term:`VOLATILE_LOG_DIR` variable by setting it to "no". + To make the ``/var/log`` directory on the target persistent, remove the + ``files/fs-perms-volatile-log.txt`` value from + :term:`FILESYSTEM_PERMS_TABLES`. - *ptest-pkgs:* Installs ptest packages for all ptest-enabled recipes. diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 0d2d255edb..d7cf48422e 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -13,7 +13,7 @@ system and gives an overview of their function and contents. :term:`K ` :term:`L ` :term:`M ` :term:`N ` :term:`O ` :term:`P` :term:`R ` :term:`S` :term:`T` -:term:`U ` :term:`V ` +:term:`U ` :term:`V ` :term:`W ` :term:`X ` .. 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``, - which is located in the ``meta/files`` folder in the :term:`Source Directory`. - If you create your own file - permissions setting table, you should place it in your layer or the - distro's layer. + By default, the OpenEmbedded build system uses the ``fs-perms.txt`` and + ``fs-perms-volatile-log.txt`` which are located in the ``meta/files`` + folder in the :term:`Source Directory`. If you create your own permission + setting table files, you should place those in your layer. - You define the :term:`FILESYSTEM_PERMS_TABLES` variable in the - ``conf/local.conf`` file, which is found in the :term:`Build Directory`, - to point to your custom ``fs-perms.txt``. You can specify more than a - single file permissions setting table. The paths you specify to these - files must be defined within the :term:`BBPATH` variable. + You can override the value of :term:`FILESYSTEM_PERMS_TABLES` variable + in your distribution configuration file to point to your custom + permission table files. You can specify one or more file permissions + setting tables. The paths that you specify to these files must be defined + within the :term:`BBPATH` variable. - For guidance on how to create your own file permissions settings - table file, examine the existing ``fs-perms.txt``. + In order to disable the volatile log, which is enabled by default, one + 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. -- cgit v1.2.3-54-g00ecf