From 22fd6955e11081c19009e7d7656dd1cefa433846 Mon Sep 17 00:00:00 2001
From: Jaroslav Mracek <jmracek@redhat.com>
Date: Mon, 1 Jul 2024 10:59:19 +0200
Subject: [PATCH] Add documentation of debuginfo-install command

It also describes dropping autoenable debug repositories for other commands.
---
 doc/changes.rst                    |  3 ++
 doc/commands/debuginfo-install.rst | 72 ++++++++++++++++++++++++++++++
 2 files changed, 75 insertions(+)
 create mode 100644 doc/commands/debuginfo-install.rst

diff --git a/doc/changes.rst b/doc/changes.rst
index 0de9dcd62..8e9130724 100644
--- a/doc/changes.rst
+++ b/doc/changes.rst
@@ -172,6 +172,9 @@ Changes to individual commands
   * Existing repository files are not modified; drop-in override files are created instead.
   * See the :ref:`config-manager documentation <config_manager_plugin_ref-label>` for more information.
 
+``debuginfo-install``
+  * Now does not support `autoupdate` functionality. The permanent enablement of debug repositories can be achieved
+    using `config-manager` command.
 ``distro-sync``
   * Now when any argument doesn't match an installed package, DNF5 fails. The behavior can be modified by the ``--skip-unavailable`` option.
   * Dropped ``distrosync`` and ``distribution-synchronization`` aliases.
diff --git a/doc/commands/debuginfo-install.rst b/doc/commands/debuginfo-install.rst
new file mode 100644
index 000000000..8af7cb58d
--- /dev/null
+++ b/doc/commands/debuginfo-install.rst
@@ -0,0 +1,72 @@
+..
+    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/>.
+
+.. _debuginfo_install_command_ref-label:
+
+##########################
+ Debuginfo-install Command
+##########################
+
+Synopsis
+========
+
+``dnf5 debuginfo-install [options] <patterns>...``
+
+
+Description
+===========
+
+Install the associated debuginfo packages for a given package specification.
+The command temporary enables corresponding debug repository for each enabled
+repository using following algorithm. When enabled repository ID has suffix `-rpm`
+then it enables <ID>-debug-rpms. When enabled repository does not have suffix `-rpm`
+it enables repository using pattern <ID>-debuginfo.
+
+When regular upgrade of debuginfo packages is expected, then it requires enabling
+of debug repository permanently using `config-manager` command.
+
+Arguments
+=========
+
+``<pattern>``
+    The pattern to install the associated debuginfo package for.
+
+Options
+=======
+
+``--allowerasing``
+    | Allow erasing of installed packages to resolve any potential dependency problems.
+
+``--skip-broken``
+    | Resolve any dependency problems by removing packages that are causing problems from the transaction.
+
+``--skip-unavailable``
+    | Allow skipping packages that are not available in repositories. All available packages will be installed.
+
+
+Examples
+========
+
+``dnf debuginfo-install foobar``
+    Install the debuginfo packages for the foobar package.
+
+``dnf upgrade --enablerepo=*-debuginfo <package-name>-debuginfo``
+    Upgrade debuginfo package of a <package-name>.
+
+``dnf upgrade --enablerepo=*-debuginfo "*-debuginfo"``
+    Upgrade all debuginfo packages.