Documentation/config/format.txt

   1 format.attach::
   2         Enable multipart/mixed attachments as the default for
   3         'format-patch'.  The value can also be a double quoted string
   4         which will enable attachments as the default and set the
   5         value as the boundary.  See the --attach option in
   6         linkgit:git-format-patch[1].  To countermand an earlier
   7         value, set it to an empty string.
   8
   9 format.from::
  10         Provides the default value for the `--from` option to format-patch.
  11         Accepts a boolean value, or a name and email address.  If false,
  12         format-patch defaults to `--no-from`, using commit authors directly in
  13         the "From:" field of patch mails.  If true, format-patch defaults to
  14         `--from`, using your committer identity in the "From:" field of patch
  15         mails and including a "From:" field in the body of the patch mail if
  16         different.  If set to a non-boolean value, format-patch uses that
  17         value instead of your committer identity.  Defaults to false.
  18
  19 format.forceInBodyFrom::
  20         Provides the default value for the `--[no-]force-in-body-from`
  21         option to format-patch.  Defaults to false.
  22
  23 format.numbered::
  24         A boolean which can enable or disable sequence numbers in patch
  25         subjects.  It defaults to "auto" which enables it only if there
  26         is more than one patch.  It can be enabled or disabled for all
  27         messages by setting it to "true" or "false".  See --numbered
  28         option in linkgit:git-format-patch[1].
  29
  30 format.headers::
  31         Additional email headers to include in a patch to be submitted
  32         by mail.  See linkgit:git-format-patch[1].
  33
  34 format.to::
  35 format.cc::
  36         Additional recipients to include in a patch to be submitted
  37         by mail.  See the --to and --cc options in
  38         linkgit:git-format-patch[1].
  39
  40 format.subjectPrefix::
  41         The default for format-patch is to output files with the '[PATCH]'
  42         subject prefix. Use this variable to change that prefix.
  43
  44 format.coverFromDescription::
  45         The default mode for format-patch to determine which parts of
  46         the cover letter will be populated using the branch's
  47         description. See the `--cover-from-description` option in
  48         linkgit:git-format-patch[1].
  49
  50 format.signature::
  51         The default for format-patch is to output a signature containing
  52         the Git version number. Use this variable to change that default.
  53         Set this variable to the empty string ("") to suppress
  54         signature generation.
  55
  56 format.signatureFile::
  57         Works just like format.signature except the contents of the
  58         file specified by this variable will be used as the signature.
  59
  60 format.suffix::
  61         The default for format-patch is to output files with the suffix
  62         `.patch`. Use this variable to change that suffix (make sure to
  63         include the dot if you want it).
  64
  65 format.encodeEmailHeaders::
  66         Encode email headers that have non-ASCII characters with
  67         "Q-encoding" (described in RFC 2047) for email transmission.
  68         Defaults to true.
  69
  70 format.pretty::
  71         The default pretty format for log/show/whatchanged command.
  72         See linkgit:git-log[1], linkgit:git-show[1],
  73         linkgit:git-whatchanged[1].
  74
  75 format.thread::
  76         The default threading style for 'git format-patch'.  Can be
  77         a boolean value, or `shallow` or `deep`.  `shallow` threading
  78         makes every mail a reply to the head of the series,
  79         where the head is chosen from the cover letter, the
  80         `--in-reply-to`, and the first patch mail, in this order.
  81         `deep` threading makes every mail a reply to the previous one.
  82         A true boolean value is the same as `shallow`, and a false
  83         value disables threading.
  84
  85 format.signOff::
  86         A boolean value which lets you enable the `-s/--signoff` option of
  87         format-patch by default. *Note:* Adding the `Signed-off-by` trailer to a
  88         patch should be a conscious act and means that you certify you have
  89         the rights to submit this work under the same open source license.
  90         Please see the 'SubmittingPatches' document for further discussion.
  91
  92 format.coverLetter::
  93         A boolean that controls whether to generate a cover-letter when
  94         format-patch is invoked, but in addition can be set to "auto", to
  95         generate a cover-letter only when there's more than one patch.
  96         Default is false.
  97
  98 format.outputDirectory::
  99         Set a custom directory to store the resulting files instead of the
 100         current working directory. All directory components will be created.
 101
 102 format.filenameMaxLength::
 103         The maximum length of the output filenames generated by the
 104         `format-patch` command; defaults to 64.  Can be overridden
 105         by the `--filename-max-length=<n>` command line option.
 106
 107 format.useAutoBase::
 108         A boolean value which lets you enable the `--base=auto` option of
 109         format-patch by default. Can also be set to "whenAble" to allow
 110         enabling `--base=auto` if a suitable base is available, but to skip
 111         adding base info otherwise without the format dying.
 112
 113 format.notes::
 114         Provides the default value for the `--notes` option to
 115         format-patch. Accepts a boolean value, or a ref which specifies
 116         where to get notes. If false, format-patch defaults to
 117         `--no-notes`. If true, format-patch defaults to `--notes`. If
 118         set to a non-boolean value, format-patch defaults to
 119         `--notes=<ref>`, where `ref` is the non-boolean value. Defaults
 120         to false.
 121 +
 122 If one wishes to use the ref `refs/notes/true`, please use that literal
 123 instead.
 124 +
 125 This configuration can be specified multiple times in order to allow
 126 multiple notes refs to be included. In that case, it will behave
 127 similarly to multiple `--[no-]notes[=]` options passed in. That is, a
 128 value of `true` will show the default notes, a value of `<ref>` will
 129 also show notes from that notes ref and a value of `false` will negate
 130 previous configurations and not show notes.
 131 +
 132 For example,
 133 +
 134 ------------
 135 [format]
 136         notes = true
 137         notes = foo
 138         notes = false
 139         notes = bar
 140 ------------
 141 +
 142 will only show notes from `refs/notes/bar`.
 143
 144 format.mboxrd::
 145         A boolean value which enables the robust "mboxrd" format when
 146         `--stdout` is in use to escape "^>+From " lines.
 147
 148 format.noprefix::
 149         If set, do not show any source or destination prefix in patches.
 150         This is equivalent to the `diff.noprefix` option used by `git
 151         diff` (but which is not respected by `format-patch`). Note that
 152         by setting this, the receiver of any patches you generate will
 153         have to apply them using the `-p0` option.