dnf5: Documentation for "check" command

rpm-software-management · Nov 29, 2023 · b9dcefd · b9dcefd
1 parent 33840a1
commit b9dcefd
Show file tree

Hide file tree

Showing 5 changed files with 62 additions and 0 deletions.
diff --git a/dnf5.spec b/dnf5.spec
@@ -259,6 +259,7 @@ It supports RPM packages, modulemd modules, and comps groups & environments.
 %{_mandir}/man8/dnf5.8.*
 %{_mandir}/man8/dnf5-advisory.8.*
 %{_mandir}/man8/dnf5-autoremove.8.*
+%{_mandir}/man8/dnf5-check.8.*
 %{_mandir}/man8/dnf5-clean.8.*
 %{_mandir}/man8/dnf5-distro-sync.8.*
 %{_mandir}/man8/dnf5-downgrade.8.*

diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
@@ -54,6 +54,7 @@ if(WITH_MAN)
         install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/dnf5.8 DESTINATION share/man/man8)
         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)
         install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/dnf5-clean.8 DESTINATION share/man/man8)
         install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/dnf5-distro-sync.8 DESTINATION share/man/man8)
         install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/dnf5-downgrade.8 DESTINATION share/man/man8)

diff --git a/doc/commands/check.8.rst b/doc/commands/check.8.rst
@@ -0,0 +1,58 @@
+..
+    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/>.
+
+.. _check_command_ref-label:
+
+####################
+ Check Command
+####################
+
+Synopsis
+========
+
+``dnf5 check [options]``
+
+
+Description
+===========
+
+Checks the local packagedb and produces information on any problems it finds.
+The set of checks performed can be specified with options.
+
+
+Options
+=======
+
+``--dependencies``
+    | Show missing dependencies and conflicts.
+
+``--duplicates``
+    | Show duplicated packages.
+
+``--obsoleted``
+    | Show obsoleted packages.
+
+
+Examples
+========
+
+``dnf5 check``
+    | Show all problems.
+
+``dnf5 check --dependencies --obsoleted``
+    | Show missing dependencies, conflicts and obsoleted packages.
diff --git a/doc/commands/index.rst b/doc/commands/index.rst
@@ -8,6 +8,7 @@ DNF5 Commands
 
     advisory.8
     autoremove.8
+    check.8
     clean.8
     distro-sync.8
     downgrade.8

diff --git a/doc/conf.py.in b/doc/conf.py.in
@@ -114,6 +114,7 @@ man_pages = [
     ('dnf5.8', 'dnf5', 'DNF5 Package Management Utility', AUTHORS, 8),
     ('commands/advisory.8', 'dnf5-advisory', 'Advisory Command', AUTHORS, 8),
     ('commands/autoremove.8', 'dnf5-autoremove', 'Autoremove Command', AUTHORS, 8),
+    ('commands/check.8', 'dnf5-check', 'Check Command', AUTHORS, 8),
     ('commands/clean.8', 'dnf5-clean', 'Clean Command', AUTHORS, 8),
     ('commands/distro-sync.8', 'dnf5-distro-sync', 'Distro-Sync Command', AUTHORS, 8),
     ('commands/downgrade.8', 'dnf5-downgrade', 'Downgrade Command', AUTHORS, 8),