Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bootc: Document --transient and persistence #2186

Open
wants to merge 1 commit into
base: bootc
Choose a base branch
from
Open

bootc: Document --transient and persistence #2186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions doc/command_ref.rst
View file
Open in desktop
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
View file
Open in desktop
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
Loading