Skip to content

Commit

Permalink
doc: document needs-restarting plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
evan-goode committed Nov 1, 2023
1 parent 438ec5f commit 8fdc07c
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 0 deletions.
1 change: 1 addition & 0 deletions doc/dnf5_plugins/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ DNF5 Plugins

builddep.8
copr.8
needs_restarting.8
repoclosure.8

..
43 changes: 43 additions & 0 deletions doc/dnf5_plugins/needs_restarting.8.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
..
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/>.

.. _needs_restarting_plugin_ref-label:

#########################
Needs-restarting Command
#########################

Synopsis
========

``dnf5 needs-restarting [--services | -s]``


Description
===========

The ``needs-restarting`` command determines whether the system should be rebooted to fully apply changes from package installations and upgrades. Without any options, ``dnf5 needs-restarting`` will report whether any important packages were installed or upgraded since boot. This set of important packages includes the kernel, systemd, each package listed here: https://access.redhat.com/solutions/27943, and any package marked with a ``reboot_suggested`` advisory.

The ``needs-restarting`` command will exit with code 1 if a reboot is recommended, or, when invoked with ``--services``, if any systemd service needs restarting. If no action is recommended, ``needs-restarting`` will exit with code 0.


Options
=======

``-s, --services``
List systemd services that need restarting. If the package that provides the service, or any of its dependencies, have been updated since the service started, then restarting the service will be recommended. Note that this approach is quite aggressive to recommend a restart when one may not be strictly necessary.

0 comments on commit 8fdc07c

Please sign in to comment.