On Thu, Apr 26, 2018 at 1:52 PM, Ben Peart <[email protected]> wrote:
> Update the documentation to better indicate that the renameLimit setting is
> ignored if rename detection is turned off via command line options or config
> settings.
>
> Signed-off-by: Ben Peart <[email protected]>
> ---
> Documentation/diff-config.txt | 3 ++-
> Documentation/merge-config.txt | 3 ++-
> 2 files changed, 4 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/diff-config.txt b/Documentation/diff-config.txt
> index 5ca942ab5e..77caa66c2f 100644
> --- a/Documentation/diff-config.txt
> +++ b/Documentation/diff-config.txt
> @@ -112,7 +112,8 @@ diff.orderFile::
>
> diff.renameLimit::
> The number of files to consider when performing the copy/rename
> - detection; equivalent to the 'git diff' option `-l`.
> + detection; equivalent to the 'git diff' option `-l`. This setting
> + has no effect if rename detection is turned off.
>
> diff.renames::
> Whether and how Git detects renames. If set to "false",
> diff --git a/Documentation/merge-config.txt b/Documentation/merge-config.txt
> index 12b6bbf591..48ee3bce77 100644
> --- a/Documentation/merge-config.txt
> +++ b/Documentation/merge-config.txt
> @@ -35,7 +35,8 @@ include::fmt-merge-msg-config.txt[]
> merge.renameLimit::
> The number of files to consider when performing rename detection
> during a merge; if not specified, defaults to the value of
> - diff.renameLimit.
> + diff.renameLimit. This setting has no effect if rename detection
> + is turned off.
>
> merge.renormalize::
> Tell Git that canonical representation of files in the
> --
> 2.17.0.windows.1
Patch looks fine, but it's hard for me not to notice a separate issue
in this area independent of your series: I'm curious if we should
document that the value of 0 is special here (as per Jonathan Tan's
commit 89973554b52c ("diffcore-rename: make diff-tree -l0 mean
-l<large>", 2017-11-29)), and doesn't actually drop the limit to 0.
cc'ing Jonathan Tan for his thoughts.
