color-words: expand docs with precise semantics
Signed-off-by: Thomas Rast <trast@student.ethz.ch> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Thomas Rast committed
Jan 17, 2009 at 17:29 UTC
c4b252c3d894673968b144d8e10b79ef22c17b0a
1 file changed
+10
-5
Documentation/diff-options.txt
+10
-5
@@ -91,12 +91,17 @@ endif::git-format-patch[]
91
Turn off colored diff, even when the configuration file
92
gives the default to color output.
93
94
---color-words[=regex]::
95
- Show colored word diff, i.e. color words which have changed.
94
+--color-words[=<regex>]::
95
+ Show colored word diff, i.e., color words which have changed.
96
+ By default, words are separated by whitespace.
97
+
97
-Optionally, you can pass a regular expression that tells Git what the
98
-words are that you are looking for; The default is to interpret any
99
-stretch of non-whitespace as a word.
98
+When a <regex> is specified, every non-overlapping match of the
99
+<regex> is considered a word. Anything between these matches is
100
+considered whitespace and ignored(!) for the purposes of finding
101
+differences. You may want to append `|[^[:space:]]` to your regular
102
+expression to make sure that it matches all non-whitespace characters.
103
+A match that contains a newline is silently truncated(!) at the
104
+newline.
105
106
--no-renames::
107
Turn off rename detection, even when the configuration