config/format.txt: clarify behavior of multiple format.notes
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>
Denton Liu committed
Dec 11, 2019 at 16:49 UTC
66f79ee23d51ac11784aeb0ef4f4119af9fbb984
1 file changed
+17
-1
Documentation/config/format.txt
+17
-1
@@ -99,4 +99,20 @@ If one wishes to use the ref `ref/notes/true`, please use that literal
99
instead.
100
+
101
This configuration can be specified multiple times in order to allow
102
-multiple notes refs to be included.
102
+multiple notes refs to be included. In that case, it will behave
103
+similarly to multiple `--[no-]notes[=]` options passed in. That is, a
104
+value of `true` will show the default notes, a value of `<ref>` will
105
+also show notes from that notes ref and a value of `false` will negate
106
+previous configurations and not show notes.
107
++
108
+For example,
109
++
110
+------------
111
+[format]
112
+ notes = true
113
+ notes = foo
114
+ notes = false
115
+ notes = bar
116
+------------
117
++
118
+will only show notes from `refs/notes/bar`.