bootc: Document `--transient` and `persistence`

Documents the new `--transient` command-line argument and `persistence`
configuration option. I tried to use a table for listing the valid
options for `persistence`, but RST does not automatically wrap table
cells containing long lines, so a list was much easier.
This commit is contained in:
Evan Goode 2024-12-17 18:58:32 +00:00
parent 0e71e95f3c
commit 77696a90ac
2 changed files with 16 additions and 0 deletions

View File

@ -387,6 +387,11 @@ Options
``--showduplicates``
Show duplicate packages in repositories. Applicable for the list and search commands.
.. _transient_option-label:
``--transient``
Applicable only on bootc (bootable containers) systems. Perform transactions using a transient overlay which will be lost on the next reboot. See also the :ref:`persistence <persistence-label>` configuration option.
.. _verbose_options-label:
``-v, --verbose``

View File

@ -442,6 +442,17 @@ configuration file by your distribution to override the DNF defaults.
Directory where DNF stores its persistent data between runs. Default is ``"/var/lib/dnf"``.
.. _persistence-label:
``persistence``
:ref:`string <string-label>`
Whether changes should persist across system reboots. Default is ``auto``. Passing :ref:`--transient <transient_option-label>` will override this setting to ``transient``. Valid values are:
* ``auto``: Changes will persist across reboots, unless the target is a running bootc system and the system is already in an unlocked state (i.e. ``/usr`` is writable).
* ``transient``: Changes will be lost on the next reboot. Only applicable on bootc systems. Beware that changes to ``/etc`` and ``/var`` will persist, depending on the configuration of your bootc system. See also https://containers.github.io/bootc/man/bootc-usr-overlay.html.
* ``persist``: Changes will persist across reboots.
.. _pluginconfpath-label:
``pluginconfpath``