Add dnf5.conf man page

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
rpm-software-management · Jan 3, 2024 · 90c8812 · 90c8812
1 parent 8a797b9
commit 90c8812
Show file tree

Hide file tree

Showing 8 changed files with 1,599 additions and 0 deletions.
diff --git a/dnf5.spec b/dnf5.spec
@@ -291,6 +291,9 @@ It supports RPM packages, modulemd modules, and comps groups & environments.
 # TODO(jkolarik): modularity is not ready yet
 # %%{_mandir}/man7/dnf5-modularity.7.*
 %{_mandir}/man7/dnf5-specs.7.*
+%{_mandir}/man5/dnf5.conf.5.*
+%{_mandir}/man5/dnf5.conf-todo.5.*
+%{_mandir}/man5/dnf5.conf-deprecated.5.*
 
 # ========== libdnf5 ==========
 %package -n libdnf5

diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
@@ -52,6 +52,9 @@ if(WITH_MAN)
 
  if(WITH_DNF5)
  install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/dnf5.8 DESTINATION share/man/man8)
+ install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/dnf5.conf.5 DESTINATION share/man/man5)
+ install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/dnf5.conf-todo.5 DESTINATION share/man/man5)
+ install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/dnf5.conf-deprecated.5 DESTINATION share/man/man5)
  install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/dnf5-advisory.8 DESTINATION share/man/man8)
  install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/dnf5-autoremove.8 DESTINATION share/man/man8)
  install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/dnf5-check.8 DESTINATION share/man/man8)

diff --git a/doc/conf.py.in b/doc/conf.py.in
@@ -149,6 +149,9 @@ man_pages = [
  ('dnf_daemon/dnf5daemon_client.8', 'dnf5daemon-client', 'Command-line interface for Dnf5daemon', AUTHORS, 8),
  ('dnf_daemon/dnf5daemon_server.8', 'dnf5daemon-server', 'Package management service with a DBus interface', AUTHORS, 8),
  ('dnf_daemon/dnf5daemon_dbus_api.8', 'dnf5daemon-dbus-api', 'DBus API Reference for Dnf5daemon', AUTHORS, 8),
+ ('dnf5.conf.5', 'dnf5.conf', 'DNF5 Configuration Reference', AUTHORS, 5),
+ ('dnf5.conf-todo.5', 'dnf5.conf-todo', 'Options that are documented/implemented in DNF but not in DNF5', AUTHORS, 5),
+ ('dnf5.conf-deprecated.5', 'dnf5.conf-deprecated', 'Config Options that are deprecated in DNF5', AUTHORS, 5),
 ]
 
 rst_prolog = """

diff --git a/doc/dnf5.8.rst b/doc/dnf5.8.rst
@@ -16,6 +16,8 @@
  You should have received a copy of the GNU General Public License
  along with libdnf. If not, see <https://www.gnu.org/licenses/>.
 
+.. _command_ref-label:
+
 ################################
  DNF5 Package Management Utility
 ################################
@@ -390,6 +392,7 @@ Miscellaneous:
  | :manpage:`dnf5-forcearch(7)`, :ref:`Forcearch parameter <forcearch_misc_ref-label>`
  | :manpage:`dnf5-installroot(7)`, :ref:`Installroot parameter <installroot_misc_ref-label>`
  | :manpage:`dnf5-specs(7)`, :ref:`Patterns specification <specs_misc_ref-label>`
+ | :manpage:`dnf5-conf(5)`, :ref:`DNF5 Configuration Reference <dnf5_conf-label>`
 
 ..
  # TODO(jkolarik): Filtering is not ready yet

diff --git a/doc/dnf5.conf-deprecated.5.rst b/doc/dnf5.conf-deprecated.5.rst
@@ -0,0 +1,45 @@
+..
+ Copyright Contributors to the libdnf project.
+
+ This file is part of libdnf: https://github.com/rpm-software-management/libdnf/
+
+ Libdnf is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 2 of the License, or
+ (at your option) any later version.
+
+ Libdnf is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with libdnf. If not, see <https://www.gnu.org/licenses/>.
+
+.. _dnf5_conf_deprecated-label:
+
+Config Options that are deprecated in DNF5
+===========================================
+
+`DNF5` has some options that are deprecated.
+This section documents the options that are deprecated and will be removed in the future.
+
+If you find any issue, please, open a ticket at https://github.com/rpm-software-management/dnf5/issues.
+
+
+ .. WARNING::
+ All config options documented here are deprecated.
+
+[main] Options
+==============
+
+.. _strict_options-label:
+
+``strict``
+ :ref:`boolean <boolean-label>`
+
+ If disabled, all unavailable packages or packages with broken dependencies given to DNF5
+ command will be skipped without raising the error causing the whole operation to fail.
+ Currently works for install command only.
+
+ Default: ``True``.