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