Skip to content

Commit

Permalink
Add documentation of debuginfo-install command
Browse files Browse the repository at this point in the history
It also describes dropping autoenable debug repositories for other commands.
  • Loading branch information
j-mracek committed Jul 1, 2024
1 parent 0ccbed8 commit 22fd695
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 0 deletions.
3 changes: 3 additions & 0 deletions doc/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
72 changes: 72 additions & 0 deletions doc/commands/debuginfo-install.rst
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 22fd695

Please sign in to comment.