summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/variables.rst
diff options
context:
space:
mode:
authorNiko Mauno <niko.mauno@vaisala.com>2024-10-16 14:09:39 +0000
committerSteve Sakoman <steve@sakoman.com>2024-10-29 05:51:03 -0700
commit61b6825c5f3be3ebd8bfc38dbff646db3a0773a1 (patch)
treeeafd3154c5eb86a40cc83a7a843f7124328ea9f7 /documentation/ref-manual/variables.rst
parentc07ed6edcde682ddf9f35d7a90d19175d0982b40 (diff)
downloadpoky-61b6825c5f3be3ebd8bfc38dbff646db3a0773a1.tar.gz
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>
Diffstat (limited to 'documentation/ref-manual/variables.rst')
-rw-r--r--documentation/ref-manual/variables.rst40
1 files changed, 18 insertions, 22 deletions
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.
13:term:`K <KARCH>` :term:`L <LABELS>` :term:`M <MACHINE>` 13:term:`K <KARCH>` :term:`L <LABELS>` :term:`M <MACHINE>`
14:term:`N <NATIVELSBSTRING>` :term:`O <OBJCOPY>` :term:`P` 14:term:`N <NATIVELSBSTRING>` :term:`O <OBJCOPY>` :term:`P`
15:term:`R <RANLIB>` :term:`S` :term:`T` 15:term:`R <RANLIB>` :term:`S` :term:`T`
16:term:`U <UBOOT_CONFIG>` :term:`V <VOLATILE_LOG_DIR>` 16:term:`U <UBOOT_CONFIG>` :term:`V <VIRTUAL-RUNTIME>`
17:term:`W <WARN_QA>` :term:`X <XSERVER>` 17:term:`W <WARN_QA>` :term:`X <XSERVER>`
18 18
19.. glossary:: 19.. glossary::
@@ -3007,26 +3007,30 @@ system and gives an overview of their function and contents.
3007 :ref:`ref-tasks-patch` task as well. 3007 :ref:`ref-tasks-patch` task as well.
3008 3008
3009 :term:`FILESYSTEM_PERMS_TABLES` 3009 :term:`FILESYSTEM_PERMS_TABLES`
3010 Allows you to define your own file permissions settings table as part 3010 Allows you to define your own file permissions settings tables as part
3011 of your configuration for the packaging process. For example, suppose 3011 of your configuration for the packaging process. For example, suppose
3012 you need a consistent set of custom permissions for a set of groups 3012 you need a consistent set of custom permissions for a set of groups
3013 and users across an entire work project. It is best to do this in the 3013 and users across an entire work project. It is best to do this in the
3014 packages themselves but this is not always possible. 3014 packages themselves but this is not always possible.
3015 3015
3016 By default, the OpenEmbedded build system uses the ``fs-perms.txt``, 3016 By default, the OpenEmbedded build system uses the ``fs-perms.txt`` and
3017 which is located in the ``meta/files`` folder in the :term:`Source Directory`. 3017 ``fs-perms-volatile-log.txt`` which are located in the ``meta/files``
3018 If you create your own file 3018 folder in the :term:`Source Directory`. If you create your own permission
3019 permissions setting table, you should place it in your layer or the 3019 setting table files, you should place those in your layer.
3020 distro's layer.
3021 3020
3022 You define the :term:`FILESYSTEM_PERMS_TABLES` variable in the 3021 You can override the value of :term:`FILESYSTEM_PERMS_TABLES` variable
3023 ``conf/local.conf`` file, which is found in the :term:`Build Directory`, 3022 in your distribution configuration file to point to your custom
3024 to point to your custom ``fs-perms.txt``. You can specify more than a 3023 permission table files. You can specify one or more file permissions
3025 single file permissions setting table. The paths you specify to these 3024 setting tables. The paths that you specify to these files must be defined
3026 files must be defined within the :term:`BBPATH` variable. 3025 within the :term:`BBPATH` variable.
3027 3026
3028 For guidance on how to create your own file permissions settings 3027 In order to disable the volatile log, which is enabled by default, one
3029 table file, examine the existing ``fs-perms.txt``. 3028 can remove the ``files/fs-perms-volatile-log.txt`` value from
3029 ``FILESYSTEM_PERMS_TABLES``.
3030
3031 For guidance on how to define your own file permissions settings
3032 tables, examine the existing ``fs-perms.txt`` and
3033 ``fs-perms-volatile-log.txt`` files.
3030 3034
3031 :term:`FIT_ADDRESS_CELLS` 3035 :term:`FIT_ADDRESS_CELLS`
3032 Specifies the value of the ``#address-cells`` value for the 3036 Specifies the value of the ``#address-cells`` value for the
@@ -10075,14 +10079,6 @@ system and gives an overview of their function and contents.
10075 10079
10076 PACKAGE_INSTALL = "${INITRAMFS_SCRIPTS} ${VIRTUAL-RUNTIME_base-utils} base-passwd" 10080 PACKAGE_INSTALL = "${INITRAMFS_SCRIPTS} ${VIRTUAL-RUNTIME_base-utils} base-passwd"
10077 10081
10078 :term:`VOLATILE_LOG_DIR`
10079 Specifies the persistence of the target's ``/var/log`` directory,
10080 which is used to house postinstall target log files.
10081
10082 By default, :term:`VOLATILE_LOG_DIR` is set to "yes", which means the
10083 file is not persistent. You can override this setting by setting the
10084 variable to "no" to make the log directory persistent.
10085
10086 :term:`VOLATILE_TMP_DIR` 10082 :term:`VOLATILE_TMP_DIR`
10087 Specifies the persistence of the target's ``/tmp`` directory. 10083 Specifies the persistence of the target's ``/tmp`` directory.
10088 10084