]> git.ipfire.org Git - thirdparty/git.git/commit
doc: clarify that --word-diff operates on line-level hunks
authorMichael Montalbo <mmontalbo@gmail.com>
Thu, 28 May 2026 19:21:45 +0000 (19:21 +0000)
committerJunio C Hamano <gitster@pobox.com>
Fri, 29 May 2026 01:11:24 +0000 (10:11 +0900)
commit1ec041bebb46159562c4beeb2e6980284e0f9a28
treee5cb3580f9610fb487eb9dc278323c2c694d0e51
parent67ad42147a7acc2af6074753ebd03d904476118f
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 an implementation note explaining the two-stage relationship
and that the output may change if Git acquires a different
implementation in the future.

Signed-off-by: Michael Montalbo <mmontalbo@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/diff-options.adoc