From: Aaron Lipman <alipman88@gmail.com>
To: git@vger.kernel.org
Cc: Aaron Lipman <alipman88@gmail.com>
Subject: [PATCH v4 2/3] Doc: cover multiple contains/no-contains filters
Date: Tue, 15 Sep 2020 22:08:39 -0400 [thread overview]
Message-ID: <20200916020840.84892-3-alipman88@gmail.com> (raw)
In-Reply-To: <20200916020840.84892-1-alipman88@gmail.com>
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 +++
Documentation/git-branch.txt | 2 ++
Documentation/git-for-each-ref.txt | 5 +++++
Documentation/git-tag.txt | 5 +++++
4 files changed, 15 insertions(+)
create mode 100644 Documentation/filters.txt
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.
diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
index 03c0824d52..aa5e4da142 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 616ce46087..c207ed9551 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 f6d9791780..dadbd71d62 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].
--
2.24.3 (Apple Git-128)
next prev parent reply other threads:[~2020-09-16 2:09 UTC|newest]
Thread overview: 36+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-08 15:37 [PATCH] ref-filter: allow merged and no-merged filters Aaron Lipman
2020-09-08 22:46 ` Junio C Hamano
2020-09-08 23:57 ` Aaron Lipman
2020-09-09 0:00 ` Junio C Hamano
2020-09-11 18:57 ` [PATCH v2 0/2] git branch: allow combining " Aaron Lipman
2020-09-11 18:57 ` [PATCH v2 1/2] t3201: test multiple branch filter combinations Aaron Lipman
2020-09-11 18:57 ` [PATCH v2 2/2] ref-filter: allow merged and no-merged filters Aaron Lipman
2020-09-11 21:47 ` Junio C Hamano
2020-09-13 19:31 ` [PATCH v3 0/3] git branch: allow combining " Aaron Lipman
2020-09-13 19:31 ` [PATCH v3 1/3] t3201: test multiple branch filter combinations Aaron Lipman
2020-09-13 20:58 ` Eric Sunshine
2020-09-14 20:07 ` Junio C Hamano
2020-09-13 19:31 ` [PATCH v3 2/3] Doc: cover multiple contains/no-contains filters Aaron Lipman
2020-09-13 21:10 ` Eric Sunshine
2020-09-14 20:07 ` Junio C Hamano
2020-09-13 19:31 ` [PATCH v3 3/3] ref-filter: allow merged and no-merged filters Aaron Lipman
2020-09-13 21:36 ` Eric Sunshine
2020-09-13 21:56 ` Junio C Hamano
2020-09-13 22:31 ` Eric Sunshine
2020-09-16 2:08 ` [PATCH v4 0/3] git branch: allow combining " Aaron Lipman
2020-09-16 2:08 ` [PATCH v4 1/3] t3201: test multiple branch filter combinations Aaron Lipman
2020-09-16 2:08 ` Aaron Lipman [this message]
2020-09-16 19:45 ` [PATCH v4 2/3] Doc: cover multiple contains/no-contains filters Junio C Hamano
2020-09-16 2:08 ` [PATCH v4 3/3] ref-filter: allow merged and no-merged filters Aaron Lipman
2020-09-16 4:53 ` [PATCH v4 0/3] git branch: allow combining " Junio C Hamano
2020-09-16 5:08 ` Eric Sunshine
2020-09-18 0:49 ` [PATCH 0/2] ref-filter: merged & no-merged touch-ups Aaron Lipman
2020-09-18 0:49 ` [PATCH 1/2] ref-filter: refactor do_merge_filter() Aaron Lipman
2020-09-18 5:03 ` Eric Sunshine
2020-09-18 5:04 ` Eric Sunshine
2020-09-18 17:01 ` Junio C Hamano
2020-09-18 0:49 ` [PATCH 2/2] Doc: prefer more specific file name Aaron Lipman
2020-09-18 2:52 ` [PATCH 0/2] ref-filter: merged & no-merged touch-ups Eric Sunshine
2020-09-18 21:58 ` [PATCH v2 " Aaron Lipman
2020-09-18 21:58 ` [PATCH v2 1/2] ref-filter: make internal reachable-filter API more precise Aaron Lipman
2020-09-18 21:58 ` [PATCH v2 2/2] Doc: prefer more specific file name Aaron Lipman
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200916020840.84892-3-alipman88@gmail.com \
--to=alipman88@gmail.com \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.