]> git.ipfire.org Git - thirdparty/git.git/commitdiff
config/format.txt: clarify behavior of multiple format.notes
authorDenton Liu <liu.denton@gmail.com>
Thu, 12 Dec 2019 00:49:47 +0000 (16:49 -0800)
committerJunio C Hamano <gitster@pobox.com>
Fri, 13 Dec 2019 19:07:00 +0000 (11:07 -0800)
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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/config/format.txt

index 414a5a8a9d7de5bbcefd928ada93aed725427b33..3d708b0aecf86fc89174f8a79ed03e8fb31825f5 100644 (file)
@@ -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`.