diff options
| author | Denton Liu <liu.denton@gmail.com> | 2019-05-17 01:14:14 +0200 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2019-05-17 05:51:53 +0200 |
| commit | 13cdf78094a5ba2968adb90707d27b98f53db1f7 (patch) | |
| tree | 5660a5b958ffa2b15e75b1170840f22271540c79 /Documentation/config/format.txt | |
| parent | git-format-patch.txt: document --no-notes option (diff) | |
| download | git-13cdf78094a5ba2968adb90707d27b98f53db1f7.tar.xz git-13cdf78094a5ba2968adb90707d27b98f53db1f7.zip | |
format-patch: teach format.notes config option
In git-format-patch, notes can be appended with the `--notes` option.
However, this must be specified by the user on an
invocation-by-invocation basis. If a user is not careful, it's possible
that they may forget to include it and generate a patch series without
notes.
Teach git-format-patch the `format.notes` config option. Its value is a
notes ref that will be automatically appended. The special value of
"standard" can be used to specify the standard notes. This option is
overridable with the `--no-notes` option in case a user wishes not to
append notes.
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 | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/Documentation/config/format.txt b/Documentation/config/format.txt index dc77941c48..414a5a8a9d 100644 --- a/Documentation/config/format.txt +++ b/Documentation/config/format.txt @@ -85,3 +85,18 @@ format.outputDirectory:: format.useAutoBase:: A boolean value which lets you enable the `--base=auto` option of format-patch by default. + +format.notes:: + Provides the default value for the `--notes` option to + format-patch. Accepts a boolean value, or a ref which specifies + where to get notes. If false, format-patch defaults to + `--no-notes`. If true, format-patch defaults to `--notes`. If + set to a non-boolean value, format-patch defaults to + `--notes=<ref>`, where `ref` is the non-boolean value. Defaults + to false. ++ +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. |