]> git.ipfire.org Git - thirdparty/git.git/commitdiff
git-revert.txt: add discussion
authorOswald Buddenhagen <oswald.buddenhagen@gmx.de>
Mon, 21 Aug 2023 17:07:20 +0000 (19:07 +0200)
committerJunio C Hamano <gitster@pobox.com>
Sat, 2 Sep 2023 22:21:44 +0000 (15:21 -0700)
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>
Documentation/git-revert.txt

index d2e10d3dceb60e0a6c8322a47f8017701338710e..cbe0208834d51f89cf9020bdf55ce96be4221ae5 100644 (file)
@@ -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
 -------------