summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Heiduk <asheiduk@gmail.com>2017-07-25 22:53:15 +0200
committerJunio C Hamano <gitster@pobox.com>2017-07-25 14:30:49 -0700
commitc0bb6d9cef66d132ba33ff4a62eda3a7038b75d0 (patch)
tree63e31ae28bb1f8d946896f05501ac4be1fbf38dc
parent95d67879735cfecfdd85f89e59d993c5b4de8835 (diff)
downloadgit-ah/doc-wserrorhighlight.tar.gz
doc: add missing values "none" and "default" for diff.wsErrorHighlightah/doc-wserrorhighlight
The values have eluded documentation so far. While at it streamline the wording by grouping relevant parts together. Signed-off-by: Andreas Heiduk <asheiduk@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r--Documentation/diff-config.txt11
-rw-r--r--Documentation/diff-options.txt17
2 files changed, 15 insertions, 13 deletions
diff --git a/Documentation/diff-config.txt b/Documentation/diff-config.txt
index cbce8ec638..5ca942ab5e 100644
--- a/Documentation/diff-config.txt
+++ b/Documentation/diff-config.txt
@@ -200,7 +200,10 @@ diff.algorithm::
+
diff.wsErrorHighlight::
- A comma separated list of `old`, `new`, `context`, that
- specifies how whitespace errors on lines are highlighted
- with `color.diff.whitespace`. Can be overridden by the
- command line option `--ws-error-highlight=<kind>`
+ Highlight whitespace errors in the `context`, `old` or `new`
+ lines of the diff. Multiple values are separated by comma,
+ `none` resets previous values, `default` reset the list to
+ `new` and `all` is a shorthand for `old,new,context`. The
+ whitespace errors are colored with `color.diff.whitespace`.
+ The command line option `--ws-error-highlight=<kind>`
+ overrides this setting.
diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
index d91ddbd5fe..5cc7c7eb71 100644
--- a/Documentation/diff-options.txt
+++ b/Documentation/diff-options.txt
@@ -301,15 +301,14 @@ ifndef::git-format-patch[]
with --exit-code.
--ws-error-highlight=<kind>::
- Highlight whitespace errors on lines specified by <kind>
- in the color specified by `color.diff.whitespace`. <kind>
- is a comma separated list of `old`, `new`, `context`. When
- this option is not given, only whitespace errors in `new`
- lines are highlighted. E.g. `--ws-error-highlight=new,old`
- highlights whitespace errors on both deleted and added lines.
- `all` can be used as a short-hand for `old,new,context`.
- The `diff.wsErrorHighlight` configuration variable can be
- used to specify the default behaviour.
+ Highlight whitespace errors in the `context`, `old` or `new`
+ lines of the diff. Multiple values are separated by comma,
+ `none` resets previous values, `default` reset the list to
+ `new` and `all` is a shorthand for `old,new,context`. When
+ this option is not given, and the configuration variable
+ `diff.wsErrorHighlight` is not set, only whitespace errors in
+ `new` lines are highlighted. The whitespace errors are colored
+ whith `color.diff.whitespace`.
endif::git-format-patch[]