From 73f7b06c06e020eaddac5eb05bd257522d4204b3 Mon Sep 17 00:00:00 2001 From: Michael Montalbo Date: Wed, 13 May 2026 07:32:18 -0700 Subject: [PATCH] doc: clarify that --word-diff operates on line-level hunks The --word-diff documentation describes the output modes and word-regex mechanics but does not explain that word-diff operates within the hunks produced by the line-level diff rather than performing an independent word-stream comparison. This can surprise users when the line-level alignment causes word-level changes to appear even though the words in both files are identical. Add a short note explaining the two-stage relationship. Signed-off-by: Michael Montalbo --- Documentation/diff-options.adoc | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Documentation/diff-options.adoc b/Documentation/diff-options.adoc index 8a63b5e164114a..665473e61a97fb 100644 --- a/Documentation/diff-options.adoc +++ b/Documentation/diff-options.adoc @@ -457,6 +457,11 @@ endif::git-diff[] + Note that despite the name of the first mode, color is used to highlight the changed parts in all modes if enabled. ++ +Word diff works by finding word-level changes within each hunk of +the line-level diff. The line-level alignment determines which +changed lines are compared to each other, which can affect the +word-level output. `--word-diff-regex=`:: Use __ to decide what a word is, instead of considering