Re: Misleading documentation for git-diff-files (diff-filter)

From: Junio C Hamano <gitster@pobox.com>
Date: Jan 4, 2018, 19:09 UTC
Message-ID: <xmqq1sj5fnkt.fsf@gitster.mtv.corp.google.com>
In-Reply-To: <20180104164941.GB18376@sigill.intra.peff.net>

Jeff King <peff@peff.net> writes:

Show 14 quoted lines

> diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
> index 9d1586b956..743af97b06 100644
> --- a/Documentation/diff-options.txt
> +++ b/Documentation/diff-options.txt
> @@ -469,6 +469,12 @@ ifndef::git-format-patch[]
>  +
>  Also, these upper-case letters can be downcased to exclude.  E.g.
>  `--diff-filter=ad` excludes added and deleted paths.
> ++
> +Note that not all diffs can feature all types. For instance, diffs
> +from the index to the working tree can never have Added entries
> +(because the set of paths included in the diff is limited by what is in
> +the index).  Similarly, copied and renamed entries cannot appear if
> +detection for those types is disabled.

Makes sense; thanks.