Skip to content

Commit

Permalink
bootc: Document --transient and persistence
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
evan-goode committed Dec 17, 2024
1 parent 0e71e95 commit f7aa7ec
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
5 changes: 5 additions & 0 deletions doc/command_ref.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 systems. Perform transactions using a transient overlay which will reset on reboot. See also the :ref:`persistence <persistence-label>` configuration option.

.. _verbose_options-label:

``-v, --verbose``
Expand Down
11 changes: 11 additions & 0 deletions doc/conf_ref.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 on system reboot. 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 reset on 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``
Expand Down

0 comments on commit f7aa7ec

Please sign in to comment.