Skip to content

Commit 415af72

Browse files
alipman88gitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent b775d81 commit 415af72

File tree

4 files changed

+15
-0
lines changed

4 files changed

+15
-0
lines changed

Documentation/filters.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -370,6 +370,8 @@ serve four related but different purposes:
370370
- `--no-merged` is used to find branches which are candidates for merging
371371
into HEAD, since those branches are not fully contained by HEAD.
372372

373+
include::filters.txt[]
374+
373375
SEE ALSO
374376
--------
375377
linkgit:git-check-ref-format[1],

Documentation/git-for-each-ref.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -408,6 +408,11 @@ Note also that multiple copies of an object may be present in the object
408408
database; in this case, it is undefined which copy's size or delta base
409409
will be reported.
410410

411+
NOTES
412+
-----
413+
414+
include::filters.txt[]
415+
411416
SEE ALSO
412417
--------
413418
linkgit:git-show-ref[1]

Documentation/git-tag.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -377,6 +377,11 @@ $ GIT_COMMITTER_DATE="2006-10-02 10:31" git tag -s v1.0.1
377377

378378
include::date-formats.txt[]
379379

380+
NOTES
381+
-----
382+
383+
include::filters.txt[]
384+
380385
SEE ALSO
381386
--------
382387
linkgit:git-check-ref-format[1].

0 commit comments

Comments
 (0)