summaryrefslogtreecommitdiff
path: root/Documentation/git-format-patch.txt
diff options
context:
space:
mode:
authorDenton Liu <liu.denton@gmail.com>2019-05-16 23:14:14 (GMT)
committerJunio C Hamano <gitster@pobox.com>2019-05-17 03:51:53 (GMT)
commit13cdf78094a5ba2968adb90707d27b98f53db1f7 (patch)
tree5660a5b958ffa2b15e75b1170840f22271540c79 /Documentation/git-format-patch.txt
parent83d9db7893e479a836b11e141c1717f0d5b829a0 (diff)
downloadgit-13cdf78094a5ba2968adb90707d27b98f53db1f7.zip
git-13cdf78094a5ba2968adb90707d27b98f53db1f7.tar.gz
git-13cdf78094a5ba2968adb90707d27b98f53db1f7.tar.bz2
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/git-format-patch.txt')
-rw-r--r--Documentation/git-format-patch.txt3
1 files changed, 3 insertions, 0 deletions
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 2c39713..9ce5b8a 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -275,6 +275,9 @@ these explanations after `format-patch` has run but before sending,
keeping them as Git notes allows them to be maintained between versions
of the patch series (but see the discussion of the `notes.rewrite`
configuration options in linkgit:git-notes[1] to use this workflow).
++
+The default is `--no-notes`, unless the `format.notes` configuration is
+set.
--[no-]signature=<signature>::
Add a signature to each message produced. Per RFC 3676 the signature