Skip to content

doc: clarify that --word-diff operates on line-level hunks#2113

Open
mmontalbo wants to merge 1 commit into
gitgitgadget:masterfrom
mmontalbo:mm/doc-word-diff
Open

doc: clarify that --word-diff operates on line-level hunks#2113
mmontalbo wants to merge 1 commit into
gitgitgadget:masterfrom
mmontalbo:mm/doc-word-diff

Conversation

@mmontalbo
Copy link
Copy Markdown

@mmontalbo mmontalbo commented May 13, 2026

CC: Vincent Lefevre vincent@vinc17.net, Johannes Sixt j6t@kdbg.org

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 <mmontalbo@gmail.com>
@mmontalbo
Copy link
Copy Markdown
Author

/preview

@gitgitgadget
Copy link
Copy Markdown

gitgitgadget Bot commented May 13, 2026

Preview email sent as pull.2113.git.1778684925795.gitgitgadget@gmail.com

@mmontalbo
Copy link
Copy Markdown
Author

/submit

@gitgitgadget
Copy link
Copy Markdown

gitgitgadget Bot commented May 13, 2026

Submitted as pull.2113.git.1778686956622.gitgitgadget@gmail.com

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-2113/mmontalbo/mm/doc-word-diff-v1

To fetch this version to local tag pr-2113/mmontalbo/mm/doc-word-diff-v1:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-2113/mmontalbo/mm/doc-word-diff-v1

@gitgitgadget
Copy link
Copy Markdown

gitgitgadget Bot commented May 14, 2026

This patch series was integrated into seen via git@39e18be.

@gitgitgadget gitgitgadget Bot added the seen label May 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant