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

Update post-transaction-actions.rst for more clarity about the syntax to use. #438

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

Update post-transaction-actions.rst for more clarity about the syntax to use. #438

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
11 changes: 10 additions & 1 deletion doc/post-transaction-actions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,17 @@ Configuration
The plugin configuration is in ``/etc/dnf/plugins/post-transaction-actions.conf``. All configuration
options are in the ``[main]`` section.

You can declare one of this variable with this syntax:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's your intention with this? Do you want to provide an example of a configuration file? To be honest it seems simple enough and not necessary. The sentence above also doesn't fit and is not well formed.


.. code-block:: none

[main]
enabled = 1
actiondir = /etc/dnf/plugins/post-transaction-actions.d/


``enabled``
Whether the plugin is enabled. Default value is ``True``.
Whether the plugin is enabled. Default value is 1.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

enabled is a boolean value and the default is indeed True, it's just that 1 also stands for True and is often used instead.


``actiondir``
Path to the directory with action files. Action files must have the ".action" extension.
Expand Down