diff options
| author | Jean-Noël Avila <jn.avila@free.fr> | 2023-12-25 21:21:26 +0000 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2023-12-26 11:06:55 -0800 |
| commit | 2162f9f6f86df4f49c3a716b5beb3952104ea8b8 (patch) | |
| tree | 9f0fec3c23e0ef98bbb46ec8ceec200355330c89 /Documentation/git-revert.txt | |
| parent | 055bb6e9969085777b7fab83e3fee0017654f134 (diff) | |
| download | git-2162f9f6f86df4f49c3a716b5beb3952104ea8b8.tar.gz | |
doc: enforce dashes in placeholders
The CodingGuidelines documents stipulates that multi-word placeholders
are to be separated by dashes, not underscores nor spaces.
Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-revert.txt')
| -rw-r--r-- | Documentation/git-revert.txt | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt index cbe0208834..568925db53 100644 --- a/Documentation/git-revert.txt +++ b/Documentation/git-revert.txt @@ -116,7 +116,7 @@ include::rerere-options.txt[] --reference:: Instead of starting the body of the log message with "This - reverts <full object name of the commit being reverted>.", + reverts <full-object-name-of-the-commit-being-reverted>.", refer to the commit using "--pretty=reference" format (cf. linkgit:git-log[1]). The `revert.reference` configuration variable can be used to enable this option by @@ -149,7 +149,7 @@ 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>""'. +unwieldy subject lines, for example 'Reapply "Reapply "<original-subject>""'. Please consider rewording these to be shorter and more unique. CONFIGURATION |