diff options
| author | Denton Liu <liu.denton@gmail.com> | 2019-12-12 03:49:47 +0300 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2019-12-13 22:07:00 +0300 |
| commit | 66f79ee23d51ac11784aeb0ef4f4119af9fbb984 (patch) | |
| tree | 8f238872e8f9f40b60c67543e797d603b370c11a /Documentation/config/format.txt | |
| parent | 09ac67a1839eda984b172d4d75153c767d6bbf14 (diff) | |
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>
Diffstat (limited to 'Documentation/config/format.txt')
| -rw-r--r-- | Documentation/config/format.txt | 18 |
1 files changed, 17 insertions, 1 deletions
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`. |