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>
Oswald Buddenhagen committed
Aug 21, 2023 at 19:07 UTC
c9192f9e45f12f7e4c93488eb77a3098e75a78cc
1 file changed
+10
Documentation/git-revert.txt
+10
@@ -142,6 +142,16 @@ EXAMPLES
142
changes. The revert only modifies the working tree and the
143
index.
144
145
+DISCUSSION
146
+----------
147
+
148
+While git creates a basic commit message automatically, it is
149
+_strongly_ recommended to explain why the original commit is being
150
+reverted.
151
+In addition, repeatedly reverting reverts will result in increasingly
152
+unwieldy subject lines, for example 'Reapply "Reapply "<original subject>""'.
153
+Please consider rewording these to be shorter and more unique.
154
+
155
CONFIGURATION
156
-------------
157