c14a06
From 195035cef51a132b2b80df57ed50f2fe620244e6 Mon Sep 17 00:00:00 2001
c14a06
From: Florence Blanc-Renaud <flo@redhat.com>
c14a06
Date: Wed, 7 Jul 2021 14:11:40 +0200
c14a06
Subject: [PATCH] man page: update ipa-server-upgrade.1
c14a06
c14a06
The man page needs to clarify in which case the command needs
c14a06
to be run.
c14a06
c14a06
Fixes: https://pagure.io/freeipa/issue/8913
c14a06
Reviewed-By: Francois Cami <fcami@redhat.com>
c14a06
---
c14a06
 install/tools/man/ipa-server-upgrade.1 | 7 ++++++-
c14a06
 1 file changed, 6 insertions(+), 1 deletion(-)
c14a06
c14a06
diff --git a/install/tools/man/ipa-server-upgrade.1 b/install/tools/man/ipa-server-upgrade.1
c14a06
index 3db19b0f1..f01e21c6b 100644
c14a06
--- a/install/tools/man/ipa-server-upgrade.1
c14a06
+++ b/install/tools/man/ipa-server-upgrade.1
c14a06
@@ -8,7 +8,12 @@ ipa\-server\-upgrade \- upgrade IPA server
c14a06
 .SH "SYNOPSIS"
c14a06
 ipa\-server\-upgrade [options]
c14a06
 .SH "DESCRIPTION"
c14a06
-ipa\-server\-upgrade is used to upgrade IPA server when the IPA packages are being updated. It is not intended to be executed by end\-users.
c14a06
+ipa\-server\-upgrade is executed automatically to upgrade IPA server when
c14a06
+the IPA packages are being updated. It is not intended to be executed by
c14a06
+end\-users, unless the automatic execution reports an error. In this case,
c14a06
+the administrator needs to identify and fix the issue that is causing the
c14a06
+upgrade failure (with the help of /var/log/ipaupgrade.log)
c14a06
+and manually re\-run ipa\-server\-upgrade.
c14a06
 
c14a06
 ipa\-server\-upgrade will:
c14a06
 
c14a06
-- 
c14a06
2.31.1
c14a06