Doc: cover multiple contains/no-contains filters
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> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Aaron Lipman committed
Sep 15, 2020 at 22:08 UTC
415af72b174802a45300039ef2bc1127d48dc0c0
4 files changed
+15
Documentation/filters.txt
new
+3
@@ -0,0 +1,3 @@
1
+When combining multiple `--contains` and `--no-contains` filters, only
2
+references that contain at least one of the `--contains` commits and
3
+contain none of the `--no-contains` commits are shown.
Documentation/git-branch.txt
+2
@@ -370,6 +370,8 @@ serve four related but different purposes:
370
- `--no-merged` is used to find branches which are candidates for merging
371
into HEAD, since those branches are not fully contained by HEAD.
372
373
+include::filters.txt[]
374
+
375
SEE ALSO
376
--------
377
linkgit:git-check-ref-format[1],
Documentation/git-for-each-ref.txt
+5
@@ -408,6 +408,11 @@ Note also that multiple copies of an object may be present in the object
408
database; in this case, it is undefined which copy's size or delta base
409
will be reported.
410
411
+NOTES
412
+-----
413
+
414
+include::filters.txt[]
415
+
416
SEE ALSO
417
--------
418
linkgit:git-show-ref[1]
Documentation/git-tag.txt
+5
@@ -377,6 +377,11 @@ $ GIT_COMMITTER_DATE="2006-10-02 10:31" git tag -s v1.0.1
377
378
include::date-formats.txt[]
379
380
+NOTES
381
+-----
382
+
383
+include::filters.txt[]
384
+
385
SEE ALSO
386
--------
387
linkgit:git-check-ref-format[1].