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