summaryrefslogtreecommitdiff
path: root/Documentation/gitdiffcore.txt
diff options
context:
space:
mode:
authorJean-Noël Avila <jn.avila@free.fr>2023-12-25 21:21:26 (GMT)
committerJunio C Hamano <gitster@pobox.com>2023-12-26 19:06:55 (GMT)
commit2162f9f6f86df4f49c3a716b5beb3952104ea8b8 (patch)
tree9f0fec3c23e0ef98bbb46ec8ceec200355330c89 /Documentation/gitdiffcore.txt
parent055bb6e9969085777b7fab83e3fee0017654f134 (diff)
downloadgit-2162f9f6f86df4f49c3a716b5beb3952104ea8b8.zip
git-2162f9f6f86df4f49c3a716b5beb3952104ea8b8.tar.gz
git-2162f9f6f86df4f49c3a716b5beb3952104ea8b8.tar.bz2
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/gitdiffcore.txt')
-rw-r--r--Documentation/gitdiffcore.txt8
1 files changed, 4 insertions, 4 deletions
diff --git a/Documentation/gitdiffcore.txt b/Documentation/gitdiffcore.txt
index 3cda2e0..642c512 100644
--- a/Documentation/gitdiffcore.txt
+++ b/Documentation/gitdiffcore.txt
@@ -245,20 +245,20 @@ diffcore-pickaxe: For Detecting Addition/Deletion of Specified String
This transformation limits the set of filepairs to those that change
specified strings between the preimage and the postimage in a certain
-way. -S<block of text> and -G<regular expression> options are used to
+way. -S<block-of-text> and -G<regular-expression> options are used to
specify different ways these strings are sought.
-"-S<block of text>" detects filepairs whose preimage and postimage
+"-S<block-of-text>" detects filepairs whose preimage and postimage
have different number of occurrences of the specified block of text.
By definition, it will not detect in-file moves. Also, when a
changeset moves a file wholesale without affecting the interesting
string, diffcore-rename kicks in as usual, and `-S` omits the filepair
(since the number of occurrences of that string didn't change in that
rename-detected filepair). When used with `--pickaxe-regex`, treat
-the <block of text> as an extended POSIX regular expression to match,
+the <block-of-text> as an extended POSIX regular expression to match,
instead of a literal string.
-"-G<regular expression>" (mnemonic: grep) detects filepairs whose
+"-G<regular-expression>" (mnemonic: grep) detects filepairs whose
textual diff has an added or a deleted line that matches the given
regular expression. This means that it will detect in-file (or what
rename-detection considers the same file) moves, which is noise. The