]> git.ipfire.org Git - thirdparty/git.git/commit
doc: clarify the intent of the renormalize option in the merge machinery
authorElijah Newren <newren@gmail.com>
Tue, 11 Feb 2025 21:01:52 +0000 (21:01 +0000)
committerJunio C Hamano <gitster@pobox.com>
Tue, 11 Feb 2025 21:34:36 +0000 (13:34 -0800)
commit45761988ac01b99f9a81ad6ec884bef3c2d8e402
treea185656dac4e96ff218eb28197f7d87a9c41df14
parent5c21db3a0d5f4414b65e114ca21c5a1fe736f2bc
doc: clarify the intent of the renormalize option in the merge machinery

The -X renormalize (or merge.renormalize config) option is intended to
reduce conflicts due to normalization of newer versions of history.  It
does so by renormalizing files that it is about to do a three-way
content merge on.  Some folks thought it would renormalize all files
throughout the tree, and the previous wording wasn't clear enough to
dispell that misconception.  Update the docs to make it clear that the
merge machinery will only apply renormalization to files which need a
three-way content merge.

(Technically, the merge machinery also does renormalization on
modify/delete conflicts, in order to see if the modification was merely
a normalization; if so, it can accept the delete and not report a
conflict.  But it's not clear that this piece needs to be explained to
users, and trying to distinguish it might feel like splitting hairs and
overcomplicating the explanation, so we leave it out.)

Signed-off-by: Elijah Newren <newren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/config/merge.txt
Documentation/gitattributes.txt
Documentation/merge-strategies.txt