From: Denton Liu <liu.denton@gmail.com>
To: Git Mailing List <git@vger.kernel.org>
Cc: Elijah Newren <newren@gmail.com>,
Eric Sunshine <sunshine@sunshineco.com>,
Philip Oakley <philipoakley@iee.email>
Subject: [PATCH 1/2] config/format.txt: clarify behavior of multiple format.notes
Date: Wed, 11 Dec 2019 16:49:47 -0800 [thread overview]
Message-ID: <af0991b2d7cd77fc077b31d4d67a556bcbd235fe.1576111643.git.liu.denton@gmail.com> (raw)
In-Reply-To: <cover.1576111643.git.liu.denton@gmail.com>
In 8164c961e1 (format-patch: use --notes behavior for format.notes,
2019-12-09), we slightly tweaked the behavior of having multiple
`format.notes` configuration variables. We did not update the
documentation to reflect this, however.
Explictly state the behavior of having multiple `format.notes`
configuration variables so users are clear on what to expect.
Signed-off-by: Denton Liu <liu.denton@gmail.com>
---
Documentation/config/format.txt | 18 +++++++++++++++++-
1 file changed, 17 insertions(+), 1 deletion(-)
diff --git a/Documentation/config/format.txt b/Documentation/config/format.txt
index 414a5a8a9d..3d708b0aec 100644
--- a/Documentation/config/format.txt
+++ b/Documentation/config/format.txt
@@ -99,4 +99,20 @@ If one wishes to use the ref `ref/notes/true`, please use that literal
instead.
+
This configuration can be specified multiple times in order to allow
-multiple notes refs to be included.
+multiple notes refs to be included. In that case, it will behave
+similarly to multiple `--[no-]notes[=]` options passed in. That is, a
+value of `true` will show the default notes, a value of `<ref>` will
+also show notes from that notes ref and a value of `false` will negate
+previous configurations and not show notes.
++
+For example,
++
+------------
+[format]
+ notes = true
+ notes = foo
+ notes = false
+ notes = bar
+------------
++
+will only show notes from `refs/notes/bar`.
--
2.24.0.627.geba02921db
next prev parent reply other threads:[~2019-12-12 0:48 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-12-12 0:49 [PATCH 0/2] dl/format-patch-notes-config-fixup: clean up some leftoverbits Denton Liu
2019-12-12 0:49 ` Denton Liu [this message]
2019-12-12 0:49 ` [PATCH 2/2] notes: break set_display_notes() into smaller functions Denton Liu
2019-12-18 16:18 ` Eric Sunshine
2019-12-18 18:17 ` [PATCH] notes.h: fix typos in comment Denton Liu
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=af0991b2d7cd77fc077b31d4d67a556bcbd235fe.1576111643.git.liu.denton@gmail.com \
--to=liu.denton@gmail.com \
--cc=git@vger.kernel.org \
--cc=newren@gmail.com \
--cc=philipoakley@iee.email \
--cc=sunshine@sunshineco.com \
/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.