| Message ID | 20241015160735.3066914-2-niko.mauno@vaisala.com |
|---|---|
| State | New |
| Headers | show |
| Series | [PATCHv2,1/2] docs: Replace VOLATILE_LOG_DIR with FILESYSTEM_PERMS_TABLES | expand |
Hi Niko, Thanks for the patches! On 15/10/2024 16:07:35+0000, Niko Mauno via lists.yoctoproject.org wrote: > 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") > > Signed-off-by: Niko Mauno <niko.mauno@vaisala.com> > --- > .../migration-guides/migration-5.1.rst | 5 ++++ > .../migration-guides/release-notes-4.2.rst | 2 +- > documentation/ref-manual/variables.rst | 29 ++++++------------- > 3 files changed, 15 insertions(+), 21 deletions(-) > > diff --git a/documentation/migration-guides/migration-5.1.rst b/documentation/migration-guides/migration-5.1.rst > index f58de3156d..64944b99cd 100644 > --- a/documentation/migration-guides/migration-5.1.rst > +++ b/documentation/migration-guides/migration-5.1.rst > @@ -122,6 +122,11 @@ The following variables have been removed: > ``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 ``FILESYSTEM_PERMS_TABLES``. > +- ``VOLATILE_TMP_DIR``: :term:`FILESYSTEM_PERMS_TABLES` is now used instead. > + By default, ``FILESYSTEM_PERMS_TABLES`` now contains the value > + ``files/fs-perms-volatile-tmp.txt``, which means that volatile tmp is > + enabled. Users can disable the volatile tmp by removing the value > + ``files/fs-perms-volatile-tmp.txt`` from ``FILESYSTEM_PERMS_TABLES``. Nit: can you add an extra space between the first and the second bullet point? To align with the rest of the doc. > .. _migration-5.1-removed-recipes: > > diff --git a/documentation/migration-guides/release-notes-4.2.rst b/documentation/migration-guides/release-notes-4.2.rst > index 30049b89f6..ac3bb9cebe 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 > > - New variables: > > - - :term:`VOLATILE_TMP_DIR` allows to specify > + - VOLATILE_TMP_DIR allows to specify > whether ``/tmp`` should be on persistent storage > or in RAM. > > diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst > index 62a225ed1b..59ecfaf016 100644 > --- a/documentation/ref-manual/variables.rst > +++ b/documentation/ref-manual/variables.rst > @@ -2994,11 +2994,11 @@ system and gives an overview of their function and contents. > 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`` and > - ``fs-perms-volatile-log.txt`` which are located in the ``meta/files`` > - folder in the :term:`Source Directory`. If you create your own file > - permission setting tables, you should place those in your layer or the > - distro's layer. > + By default, the OpenEmbedded build system uses the ``fs-perms.txt``, > + ``fs-perms-volatile-log.txt`` and ``fs-perms-volatile-tmp.txt`` which are > + located in the ``meta/files`` folder in the :term:`Source Directory`. If > + you create your own file permission setting tables, you should place s/your own file permission setting tables/your own permission setting table files/? > + those in your layer or the distro's layer. Seems confusing to me… I would just say "those in your layer.". > You can override the value of :term:`FILESYSTEM_PERMS_TABLES` variable > in the ``conf/local.conf`` file, which is found in the > @@ -3009,11 +3009,12 @@ system and gives an overview of their function and contents. > > 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``. > + ``FILESYSTEM_PERMS_TABLES``. Similarly, in order to disable the volatile > + tmp, one can remove the ``files/fs-perms-volatile-tmp.txt`` value. > > For guidance on how to create your own file permissions settings > - table files, examine the existing ``fs-perms.txt`` and > - ``fs-perms-volatile-log.txt``. > + table files, examine the existing ``fs-perms.txt``, > + ``fs-perms-volatile-log.txt`` and ``fs-perms-volatile-tmp.txt``. I would end this sentence with "files": "...and ``fs-perms-volatile-tmp.txt`` files.". Cheers, Antonin -- Antonin Godard, Bootlin Embedded Linux and Kernel engineering https://bootlin.com
Thanks, submitted v3 which applies the changes otherwise as suggested, however in the last item I slightly modified the first half of the sentence too (to avoid using the word 'files' twice in the same sentence) - For guidance on how to create your own file permissions settings - table files, examine the existing ``fs-perms.txt``, - ``fs-perms-volatile-log.txt`` and ``fs-perms-volatile-tmp.txt``. + For guidance on how to define your own file permissions settings + tables, examine the existing ``fs-perms.txt``, + ``fs-perms-volatile-log.txt`` and ``fs-perms-volatile-tmp.txt`` files. Please advise if there is any issue. -Niko On 16.10.2024 11.12, Antonin Godard wrote: > [You don't often get email from antonin.godard@bootlin.com. Learn why this is important at https://aka.ms/LearnAboutSenderIdentification ] > > Hi Niko, > > Thanks for the patches! > > On 15/10/2024 16:07:35+0000, Niko Mauno via lists.yoctoproject.org wrote: >> 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") >> >> Signed-off-by: Niko Mauno <niko.mauno@vaisala.com> >> --- >> .../migration-guides/migration-5.1.rst | 5 ++++ >> .../migration-guides/release-notes-4.2.rst | 2 +- >> documentation/ref-manual/variables.rst | 29 ++++++------------- >> 3 files changed, 15 insertions(+), 21 deletions(-) >> >> diff --git a/documentation/migration-guides/migration-5.1.rst b/documentation/migration-guides/migration-5.1.rst >> index f58de3156d..64944b99cd 100644 >> --- a/documentation/migration-guides/migration-5.1.rst >> +++ b/documentation/migration-guides/migration-5.1.rst >> @@ -122,6 +122,11 @@ The following variables have been removed: >> ``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 ``FILESYSTEM_PERMS_TABLES``. >> +- ``VOLATILE_TMP_DIR``: :term:`FILESYSTEM_PERMS_TABLES` is now used instead. >> + By default, ``FILESYSTEM_PERMS_TABLES`` now contains the value >> + ``files/fs-perms-volatile-tmp.txt``, which means that volatile tmp is >> + enabled. Users can disable the volatile tmp by removing the value >> + ``files/fs-perms-volatile-tmp.txt`` from ``FILESYSTEM_PERMS_TABLES``. > > Nit: can you add an extra space between the first and the second bullet point? > To align with the rest of the doc. > >> .. _migration-5.1-removed-recipes: >> >> diff --git a/documentation/migration-guides/release-notes-4.2.rst b/documentation/migration-guides/release-notes-4.2.rst >> index 30049b89f6..ac3bb9cebe 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 >> >> - New variables: >> >> - - :term:`VOLATILE_TMP_DIR` allows to specify >> + - VOLATILE_TMP_DIR allows to specify >> whether ``/tmp`` should be on persistent storage >> or in RAM. >> >> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst >> index 62a225ed1b..59ecfaf016 100644 >> --- a/documentation/ref-manual/variables.rst >> +++ b/documentation/ref-manual/variables.rst >> @@ -2994,11 +2994,11 @@ system and gives an overview of their function and contents. >> 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`` and >> - ``fs-perms-volatile-log.txt`` which are located in the ``meta/files`` >> - folder in the :term:`Source Directory`. If you create your own file >> - permission setting tables, you should place those in your layer or the >> - distro's layer. >> + By default, the OpenEmbedded build system uses the ``fs-perms.txt``, >> + ``fs-perms-volatile-log.txt`` and ``fs-perms-volatile-tmp.txt`` which are >> + located in the ``meta/files`` folder in the :term:`Source Directory`. If >> + you create your own file permission setting tables, you should place > > s/your own file permission setting tables/your own permission setting table files/? > >> + those in your layer or the distro's layer. > > Seems confusing to me… I would just say "those in your layer.". > >> You can override the value of :term:`FILESYSTEM_PERMS_TABLES` variable >> in the ``conf/local.conf`` file, which is found in the >> @@ -3009,11 +3009,12 @@ system and gives an overview of their function and contents. >> >> 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``. >> + ``FILESYSTEM_PERMS_TABLES``. Similarly, in order to disable the volatile >> + tmp, one can remove the ``files/fs-perms-volatile-tmp.txt`` value. >> >> For guidance on how to create your own file permissions settings >> - table files, examine the existing ``fs-perms.txt`` and >> - ``fs-perms-volatile-log.txt``. >> + table files, examine the existing ``fs-perms.txt``, >> + ``fs-perms-volatile-log.txt`` and ``fs-perms-volatile-tmp.txt``. > > I would end this sentence with "files": "...and ``fs-perms-volatile-tmp.txt`` > files.". > > Cheers, > Antonin > > -- > Antonin Godard, Bootlin > Embedded Linux and Kernel engineering > https://bootlin.com/
diff --git a/documentation/migration-guides/migration-5.1.rst b/documentation/migration-guides/migration-5.1.rst index f58de3156d..64944b99cd 100644 --- a/documentation/migration-guides/migration-5.1.rst +++ b/documentation/migration-guides/migration-5.1.rst @@ -122,6 +122,11 @@ The following variables have been removed: ``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 ``FILESYSTEM_PERMS_TABLES``. +- ``VOLATILE_TMP_DIR``: :term:`FILESYSTEM_PERMS_TABLES` is now used instead. + By default, ``FILESYSTEM_PERMS_TABLES`` now contains the value + ``files/fs-perms-volatile-tmp.txt``, which means that volatile tmp is + enabled. Users can disable the volatile tmp by removing the value + ``files/fs-perms-volatile-tmp.txt`` from ``FILESYSTEM_PERMS_TABLES``. .. _migration-5.1-removed-recipes: diff --git a/documentation/migration-guides/release-notes-4.2.rst b/documentation/migration-guides/release-notes-4.2.rst index 30049b89f6..ac3bb9cebe 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 - New variables: - - :term:`VOLATILE_TMP_DIR` allows to specify + - VOLATILE_TMP_DIR allows to specify whether ``/tmp`` should be on persistent storage or in RAM. diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 62a225ed1b..59ecfaf016 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -2994,11 +2994,11 @@ system and gives an overview of their function and contents. 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`` and - ``fs-perms-volatile-log.txt`` which are located in the ``meta/files`` - folder in the :term:`Source Directory`. If you create your own file - permission setting tables, you should place those in your layer or the - distro's layer. + By default, the OpenEmbedded build system uses the ``fs-perms.txt``, + ``fs-perms-volatile-log.txt`` and ``fs-perms-volatile-tmp.txt`` which are + located in the ``meta/files`` folder in the :term:`Source Directory`. If + you create your own file permission setting tables, you should place + those in your layer or the distro's layer. You can override the value of :term:`FILESYSTEM_PERMS_TABLES` variable in the ``conf/local.conf`` file, which is found in the @@ -3009,11 +3009,12 @@ system and gives an overview of their function and contents. 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``. + ``FILESYSTEM_PERMS_TABLES``. Similarly, in order to disable the volatile + tmp, one can remove the ``files/fs-perms-volatile-tmp.txt`` value. For guidance on how to create your own file permissions settings - table files, examine the existing ``fs-perms.txt`` and - ``fs-perms-volatile-log.txt``. + table files, examine the existing ``fs-perms.txt``, + ``fs-perms-volatile-log.txt`` and ``fs-perms-volatile-tmp.txt``. :term:`FIT_ADDRESS_CELLS` Specifies the value of the ``#address-cells`` value for the @@ -9989,18 +9990,6 @@ system and gives an overview of their function and contents. PACKAGE_INSTALL = "${INITRAMFS_SCRIPTS} ${VIRTUAL-RUNTIME_base-utils} base-passwd" - :term:`VOLATILE_TMP_DIR` - Specifies the persistence of the target's ``/tmp`` directory. - - By default, :term:`VOLATILE_TMP_DIR` is set to "yes", in which case - ``/tmp`` links to a directory which resides in RAM in a ``tmpfs`` - filesystem. - - If instead, you want the ``/tmp`` directory to be persistent, set the - variable to "no" to make it a regular directory in the root filesystem. - - This supports both sysvinit and systemd based systems. - :term:`WARN_QA` Specifies the quality assurance checks whose failures are reported as warnings by the OpenEmbedded build system. You set this variable in
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") Signed-off-by: Niko Mauno <niko.mauno@vaisala.com> --- .../migration-guides/migration-5.1.rst | 5 ++++ .../migration-guides/release-notes-4.2.rst | 2 +- documentation/ref-manual/variables.rst | 29 ++++++------------- 3 files changed, 15 insertions(+), 21 deletions(-)