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.

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

Add dnf5.conf man page #751

Merged
merged 1 commit into from
Jan 5, 2024

Conversation

inknos
Copy link
Collaborator

@inknos inknos commented Jul 20, 2023

This PR adds the man page (5) for dnf5 options that can be used in dnf.conf.

  • check options described in dnf4 that are not used in dnf5
    • document unused/deprecated options
    • add options in dnf5
  • check dnf5 implemented options and decide how to document them
  • decide on what to do with distribution specific options
  • check english

Closes: #309

@inknos inknos force-pushed the ns-dnf5-config-man branch 4 times, most recently from b3c880e to ed61aba Compare July 21, 2023 13:38
@inknos inknos marked this pull request as ready for review July 21, 2023 13:39
@inknos inknos force-pushed the ns-dnf5-config-man branch 2 times, most recently from 362d65c to ebcb650 Compare July 21, 2023 13:47
@inknos inknos force-pushed the ns-dnf5-config-man branch from ebcb650 to a59ed6a Compare July 21, 2023 14:03
doc/CMakeLists.txt Outdated Show resolved Hide resolved
doc/dnf5.conf.5.rst Outdated Show resolved Hide resolved
@inknos
Copy link
Collaborator Author

inknos commented Aug 29, 2023

closes #309

doc/dnf5.conf.5.rst Outdated Show resolved Hide resolved
doc/dnf5.conf.5.rst Outdated Show resolved Hide resolved
doc/dnf5.conf.5.rst Outdated Show resolved Hide resolved
doc/dnf5.conf.5.rst Outdated Show resolved Hide resolved
doc/dnf5.conf.5.rst Outdated Show resolved Hide resolved
@@ -0,0 +1,1366 @@
..
Copy link
Member

Choose a reason for hiding this comment

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

I guess we can also add info about processing the configuration options priorities like MAINCONFIG, COMMANDLINE, RUNTIME etc.

@jan-kolarik
Copy link
Member

Not in the scope of current PR, but what do you think about including similar information, as found in a man page, within the dnf5.conf template file? For example, similar to how the Apache Web Server provides commented-out lines with default values and descriptions...

@m-blaha
Copy link
Member

m-blaha commented Sep 11, 2023

@jan-kolarik On the other hand, having as many config options as dnf have can make the config file harder to read and maintain for the user.

@jan-kolarik
Copy link
Member

@jan-kolarik On the other hand, having as many config options as dnf have can make the config file harder to read and maintain for the user.

Yep, it could be. I feel like having the descriptions and examples on a single place might be easier for a non-expert dnf user.

@j-mracek
Copy link
Contributor

@inknos I see that PR is open for so log - May I ask you whether is it possible to finish the work, or split it?

@inknos
Copy link
Collaborator Author

inknos commented Oct 16, 2023

I see that PR is open for so log - May I ask you whether is it possible to finish the work, or split it?

It is very difficult to provide a doc in one go. maybe split is the solution.

@inknos inknos force-pushed the ns-dnf5-config-man branch 3 times, most recently from 364b2ee to ff1ba58 Compare January 3, 2024 10:57
add dnf5.conf-todo.5.rst page which documents differences between dnf4
add dnf5.conf-deprecated.5.rst page which documents deprecated options
and dnf5 config options
@inknos inknos force-pushed the ns-dnf5-config-man branch from ff1ba58 to 90c8812 Compare January 3, 2024 11:48
Copy link
Member

@m-blaha m-blaha left a comment

Choose a reason for hiding this comment

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

Thank you!

@m-blaha m-blaha added this pull request to the merge queue Jan 5, 2024
Merged via the queue into rpm-software-management:main with commit b5564f5 Jan 5, 2024
5 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Create documentation for dnf configuration
5 participants