Re: [PATCH v4 2/3] Doc: cover multiple contains/no-contains filters

From: Junio C Hamano <gitster@pobox.com>
Date: Sep 16, 2020, 19:45 UTC
Message-ID: <xmqq4knxy08w.fsf@gitster.c.googlers.com>
In-Reply-To: <20200916020840.84892-3-alipman88@gmail.com>

Aaron Lipman <alipman88@gmail.com> writes:

Show 11 quoted lines

> Update documentation for "git branch", "git for-each-ref" and "git tag"
> with notes explaining what happens when passed multiple --contains or
> --no-contains filters.
>
> This behavior is useful to document prior to enabling multiple
> merged/no-merged filters, in order to demonstrate consistent behavior
> between merged/no-merged and contains/no-contains filters.
>
> Signed-off-by: Aaron Lipman <alipman88@gmail.com>
> ---
>  Documentation/filters.txt          | 3 +++

"git" has more than one concepts that relate to the word "filter", like the one that are used to create lazy clone, the "filter-branch" command, "smudge/clean" filter, "textconv" filter used by the diff and grep machinery to name some.

Make sure you do not accidentally squat on a good-sounding but an overly generic name. ref-reachability-filters.txt perhaps?

Show 9 quoted lines

> diff --git a/Documentation/filters.txt b/Documentation/filters.txt
> new file mode 100644
> index 0000000000..4ee17afc01
> --- /dev/null
> +++ b/Documentation/filters.txt
> @@ -0,0 +1,3 @@
> +When combining multiple `--contains` and `--no-contains` filters, only
> +references that contain at least one of the `--contains` commits and
> +contain none of the `--no-contains` commits are shown.