Skip to content

Commit

Permalink
doc: Enhance history documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kontura committed Jan 22, 2025
1 parent 0e73f49 commit 088fc7b
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
8 changes: 8 additions & 0 deletions doc/commands/history.8.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,30 +37,38 @@ and offers several operations on these transactions, like undoing and redoing th
use the transactions in these commands, it is assumed that they were committed while using the
``history_record`` configuration option.

For more information about ``<transaction-spec>`` see
:manpage:`dnf5-specs(7)`, :ref:`Patterns specification <transaction_spec-label>`.

Subcommands
===========

``list``
| List info about recorded transactions in the system.
| If no ``<transaction-spec>`` is specified it uses all transactions.
``info``
| Print details about specific transactions.
| If no ``<transaction-spec>`` is specified it uses the last transaction.
``undo``
| Revert all actions from the specified transaction.
| Exactly one transaction must be specified by ``<transaction-spec>``.
``redo``
| Repeat the specified transaction.
| Automatically uses ``--ignore-extras`` and ``--ignore-installed``.
| Unlike the rest of history commands it overrides reasons for transaction packages that are already installed.
| This command is useful to finish interrupted transactons.
| Exactly one transaction must be specified by ``<transaction-spec>``.
``rollback``
| Undo all transactions performed after the specified transaction.
| Exactly one transaction must be specified by ``<transaction-spec>``.
``store``
| Store the transaction into a directory.
| If no ``<transaction-spec>`` is specified it uses the last transaction.

Options for ``list`` and ``info``
Expand Down
1 change: 1 addition & 0 deletions doc/misc/specs.7.rst
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,7 @@ Since `NEVRA` matching form is insufficient for modules, they are uniquely ident
In case stream is not specified, the enabled or the default stream is used, in this order.
In case profile is not specified, the system default profile or the 'default' profile is used.

.. _transaction_spec-label:

Transactions
============
Expand Down

0 comments on commit 088fc7b

Please sign in to comment.