diff options
| author | Aaron Lipman <alipman88@gmail.com> | 2020-09-16 02:08:39 (GMT) |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2020-09-16 19:38:09 (GMT) |
| commit | 415af72b174802a45300039ef2bc1127d48dc0c0 (patch) | |
| tree | 5467912f3d5dc1ee808e3a63f780747e6bd4b133 | |
| parent | b775d8122ecec94a99c1a6588a38455cdd41d8e2 (diff) | |
| download | git-415af72b174802a45300039ef2bc1127d48dc0c0.zip git-415af72b174802a45300039ef2bc1127d48dc0c0.tar.gz git-415af72b174802a45300039ef2bc1127d48dc0c0.tar.bz2 | |
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>
| -rw-r--r-- | Documentation/filters.txt | 3 | ||||
| -rw-r--r-- | Documentation/git-branch.txt | 2 | ||||
| -rw-r--r-- | Documentation/git-for-each-ref.txt | 5 | ||||
| -rw-r--r-- | Documentation/git-tag.txt | 5 |
4 files changed, 15 insertions, 0 deletions
diff --git a/Documentation/filters.txt b/Documentation/filters.txt new file mode 100644 index 0000000..4ee17af --- /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. diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt index 03c0824..aa5e4da 100644 --- a/Documentation/git-branch.txt +++ b/Documentation/git-branch.txt @@ -370,6 +370,8 @@ serve four related but different purposes: - `--no-merged` is used to find branches which are candidates for merging into HEAD, since those branches are not fully contained by HEAD. +include::filters.txt[] + SEE ALSO -------- linkgit:git-check-ref-format[1], diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt index 616ce46..c207ed9 100644 --- a/Documentation/git-for-each-ref.txt +++ b/Documentation/git-for-each-ref.txt @@ -408,6 +408,11 @@ Note also that multiple copies of an object may be present in the object database; in this case, it is undefined which copy's size or delta base will be reported. +NOTES +----- + +include::filters.txt[] + SEE ALSO -------- linkgit:git-show-ref[1] diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt index f6d9791..dadbd71 100644 --- a/Documentation/git-tag.txt +++ b/Documentation/git-tag.txt @@ -377,6 +377,11 @@ $ GIT_COMMITTER_DATE="2006-10-02 10:31" git tag -s v1.0.1 include::date-formats.txt[] +NOTES +----- + +include::filters.txt[] + SEE ALSO -------- linkgit:git-check-ref-format[1]. |