summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorNiko Mauno <niko.mauno@vaisala.com>2024-10-16 14:09:40 +0000
committerSteve Sakoman <steve@sakoman.com>2024-10-29 05:51:03 -0700
commit59a0d5753cb8be0a940c81cb9b97c10fbd616ffe (patch)
tree7c7f3ba385b9aa67cfb32405d6d9cea4b5e60b55 /documentation
parent61b6825c5f3be3ebd8bfc38dbff646db3a0773a1 (diff)
downloadpoky-59a0d5753cb8be0a940c81cb9b97c10fbd616ffe.tar.gz
docs: Replace VOLATILE_TMP_DIR with FILESYSTEM_PERMS_TABLES
The VOLATILE_TMP_DIR variable was removed and it's functionality replaced with a FILESYSTEM_PERMS_TABLES entry in https://git.yoctoproject.org/poky/commit/?id=2f46b6f27dfa3a9d5ad177900fcecfe64c3536f1 ("bitbake.conf: drop VOLATILE_TMP_DIR, use FILESYSTEM_PERMS_TABLES instead") (From yocto-docs rev: 92aef324d06f1f257fc3896b63c4c744d19c0853) 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 1ef0eabaa07cc39075a040b99a5c11567d745408) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/migration-guides/migration-5.1.rst6
-rw-r--r--documentation/migration-guides/release-notes-4.2.rst2
-rw-r--r--documentation/ref-manual/variables.rst28
3 files changed, 16 insertions, 20 deletions
diff --git a/documentation/migration-guides/migration-5.1.rst b/documentation/migration-guides/migration-5.1.rst
index 18b445c6b5..d3c28f8b34 100644
--- a/documentation/migration-guides/migration-5.1.rst
+++ b/documentation/migration-guides/migration-5.1.rst
@@ -148,6 +148,12 @@ The following variables have been removed:
148 enabled. Users can disable the volatile log by removing the value 148 enabled. Users can disable the volatile log by removing the value
149 ``files/fs-perms-volatile-log.txt`` from :term:`FILESYSTEM_PERMS_TABLES`. 149 ``files/fs-perms-volatile-log.txt`` from :term:`FILESYSTEM_PERMS_TABLES`.
150 150
151- ``VOLATILE_TMP_DIR``: :term:`FILESYSTEM_PERMS_TABLES` is now used instead.
152 By default, :term:`FILESYSTEM_PERMS_TABLES` now contains the value
153 ``files/fs-perms-volatile-tmp.txt``, which means that volatile tmp is
154 enabled. Users can disable the volatile tmp by removing the value
155 ``files/fs-perms-volatile-tmp.txt`` from :term:`FILESYSTEM_PERMS_TABLES`.
156
151.. _migration-5.1-removed-recipes: 157.. _migration-5.1-removed-recipes:
152 158
153Removed recipes 159Removed recipes
diff --git a/documentation/migration-guides/release-notes-4.2.rst b/documentation/migration-guides/release-notes-4.2.rst
index 30049b89f6..ee81d8367a 100644
--- a/documentation/migration-guides/release-notes-4.2.rst
+++ b/documentation/migration-guides/release-notes-4.2.rst
@@ -38,7 +38,7 @@ New Features / Enhancements in 4.2
38 38
39- New variables: 39- New variables:
40 40
41 - :term:`VOLATILE_TMP_DIR` allows to specify 41 - ``VOLATILE_TMP_DIR`` allows to specify
42 whether ``/tmp`` should be on persistent storage 42 whether ``/tmp`` should be on persistent storage
43 or in RAM. 43 or in RAM.
44 44
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index d7cf48422e..dc7a19efef 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -3013,10 +3013,11 @@ system and gives an overview of their function and contents.
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`` and 3016 By default, the OpenEmbedded build system uses the ``fs-perms.txt``,
3017 ``fs-perms-volatile-log.txt`` which are located in the ``meta/files`` 3017 ``fs-perms-volatile-log.txt`` and ``fs-perms-volatile-tmp.txt`` which are
3018 folder in the :term:`Source Directory`. If you create your own permission 3018 located in the ``meta/files`` folder in the :term:`Source Directory`. If
3019 setting table files, you should place those in your layer. 3019 you create your own permission setting table files, you should place
3020 those in your layer.
3020 3021
3021 You can override the value of :term:`FILESYSTEM_PERMS_TABLES` variable 3022 You can override the value of :term:`FILESYSTEM_PERMS_TABLES` variable
3022 in your distribution configuration file to point to your custom 3023 in your distribution configuration file to point to your custom
@@ -3026,11 +3027,12 @@ system and gives an overview of their function and contents.
3026 3027
3027 In order to disable the volatile log, which is enabled by default, one 3028 In order to disable the volatile log, which is enabled by default, one
3028 can remove the ``files/fs-perms-volatile-log.txt`` value from 3029 can remove the ``files/fs-perms-volatile-log.txt`` value from
3029 ``FILESYSTEM_PERMS_TABLES``. 3030 ``FILESYSTEM_PERMS_TABLES``. Similarly, in order to disable the volatile
3031 tmp, one can remove the ``files/fs-perms-volatile-tmp.txt`` value.
3030 3032
3031 For guidance on how to define your own file permissions settings 3033 For guidance on how to define your own file permissions settings
3032 tables, examine the existing ``fs-perms.txt`` and 3034 tables, examine the existing ``fs-perms.txt``,
3033 ``fs-perms-volatile-log.txt`` files. 3035 ``fs-perms-volatile-log.txt`` and ``fs-perms-volatile-tmp.txt`` files.
3034 3036
3035 :term:`FIT_ADDRESS_CELLS` 3037 :term:`FIT_ADDRESS_CELLS`
3036 Specifies the value of the ``#address-cells`` value for the 3038 Specifies the value of the ``#address-cells`` value for the
@@ -10079,18 +10081,6 @@ system and gives an overview of their function and contents.
10079 10081
10080 PACKAGE_INSTALL = "${INITRAMFS_SCRIPTS} ${VIRTUAL-RUNTIME_base-utils} base-passwd" 10082 PACKAGE_INSTALL = "${INITRAMFS_SCRIPTS} ${VIRTUAL-RUNTIME_base-utils} base-passwd"
10081 10083
10082 :term:`VOLATILE_TMP_DIR`
10083 Specifies the persistence of the target's ``/tmp`` directory.
10084
10085 By default, :term:`VOLATILE_TMP_DIR` is set to "yes", in which case
10086 ``/tmp`` links to a directory which resides in RAM in a ``tmpfs``
10087 filesystem.
10088
10089 If instead, you want the ``/tmp`` directory to be persistent, set the
10090 variable to "no" to make it a regular directory in the root filesystem.
10091
10092 This supports both sysvinit and systemd based systems.
10093
10094 :term:`WARN_QA` 10084 :term:`WARN_QA`
10095 Specifies the quality assurance checks whose failures are reported as 10085 Specifies the quality assurance checks whose failures are reported as
10096 warnings by the OpenEmbedded build system. You set this variable in 10086 warnings by the OpenEmbedded build system. You set this variable in