From: Oswald Buddenhagen <oswald.buddenhagen@gmx.de>
Date: Mon, 21 Aug 2023 17:07:20 +0000 (+0200)
Subject: git-revert.txt: add discussion
X-Git-Tag: v2.43.0-rc0~91^2
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=c9192f9e45f12f7e4c93488eb77a3098e75a78cc;p=thirdparty%2Fgit.git

git-revert.txt: add discussion

The section is inspired by git-commit.txt.

Signed-off-by: Oswald Buddenhagen <oswald.buddenhagen@gmx.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---

diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt
index d2e10d3dce..cbe0208834 100644
--- a/Documentation/git-revert.txt
+++ b/Documentation/git-revert.txt
@@ -142,6 +142,16 @@ EXAMPLES
 	changes. The revert only modifies the working tree and the
 	index.
 
+DISCUSSION
+----------
+
+While git creates a basic commit message automatically, it is
+_strongly_ recommended to explain why the original commit is being
+reverted.
+In addition, repeatedly reverting reverts will result in increasingly
+unwieldy subject lines, for example 'Reapply "Reapply "<original subject>""'.
+Please consider rewording these to be shorter and more unique.
+
 CONFIGURATION
 -------------