[PATCH v4 2/2] git-revert.txt: add discussion
The section is inspired by git-commit.txt.
Signed-off-by: Oswald Buddenhagen <oswald.buddenhagen@gmx.de>
---
v4:
- adjusted summary prefix & payload wording
Cc: Junio C Hamano <gitster@pobox.com>
Cc: Linus Arver <linusa@google.com>
Cc: Phillip Wood <phillip.wood123@gmail.com>
Cc: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
Documentation/git-revert.txt | 10 ++++++++++
1 file changed, 10 insertions(+)
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
-------------
--
2.40.0.152.g15d061e6df
Oswald Buddenhagen <oswald.buddenhagen@gmx.de>