logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

git-mailinfo.1 (6248B)

    

  1. '\" t
  2. .\"     Title: git-mailinfo
  3. .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
  4. .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
  5. .\"      Date: 2025-03-14
  6. .\"    Manual: Git Manual
  7. .\"    Source: Git 2.49.0
  8. .\"  Language: English
  9. .\"
  10. .TH "GIT\-MAILINFO" "1" "2025-03-14" "Git 2\&.49\&.0" "Git Manual"
  11. .\" -----------------------------------------------------------------
  12. .\" * Define some portability stuff
  13. .\" -----------------------------------------------------------------
  14. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15. .\" http://bugs.debian.org/507673
  16. .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18. .ie \n(.g .ds Aq \(aq
  19. .el       .ds Aq '
  20. .\" -----------------------------------------------------------------
  21. .\" * set default formatting
  22. .\" -----------------------------------------------------------------
  23. .\" disable hyphenation
  24. .nh
  25. .\" disable justification (adjust text to left margin only)
  26. .ad l
  27. .\" -----------------------------------------------------------------
  28. .\" * MAIN CONTENT STARTS HERE *
  29. .\" -----------------------------------------------------------------
  30. .SH "NAME"
  31. git-mailinfo \- Extracts patch and authorship from a single e\-mail message
  32. .SH "SYNOPSIS"
  33. .sp
  34. .nf
  35. \fIgit mailinfo\fR [\-k|\-b] [\-u | \-\-encoding=<encoding> | \-n]
  36.                [\-\-[no\-]scissors] [\-\-quoted\-cr=<action>]
  37.                <msg> <patch>
  38. .fi
  39. .SH "DESCRIPTION"
  40. .sp
  41. Reads a single e\-mail message from the standard input, and writes the commit log message in <msg> file, and the patches in <patch> file\&. The author name, e\-mail and e\-mail subject are written out to the standard output to be used by \fIgit am\fR to create a commit\&. It is usually not necessary to use this command directly\&. See \fBgit-am\fR(1) instead\&.
  42. .SH "OPTIONS"
  43. .PP
  44. \-k
  45. .RS 4
  46. Usually the program removes email cruft from the Subject: header line to extract the title line for the commit log message\&. This option prevents this munging, and is most useful when used to read back
  47. \fIgit format\-patch \-k\fR
  48. output\&.
  49. .sp
  50. Specifically, the following are removed until none of them remain:
  51. .sp
  52. .RS 4
  53. .ie n \{\
  54. \h'-04'\(bu\h'+03'\c
  55. .\}
  56. .el \{\
  57. .sp -1
  58. .IP \(bu 2.3
  59. .\}
  60. Leading and trailing whitespace\&.
  61. .RE
  62. .sp
  63. .RS 4
  64. .ie n \{\
  65. \h'-04'\(bu\h'+03'\c
  66. .\}
  67. .el \{\
  68. .sp -1
  69. .IP \(bu 2.3
  70. .\}
  71. Leading
  72. \fBRe:\fR,
  73. \fBre:\fR, and
  74. \fB:\fR\&.
  75. .RE
  76. .sp
  77. .RS 4
  78. .ie n \{\
  79. \h'-04'\(bu\h'+03'\c
  80. .\}
  81. .el \{\
  82. .sp -1
  83. .IP \(bu 2.3
  84. .\}
  85. Leading bracketed strings (between [ and ], usually [\fBPATCH\fR])\&.
  86. .RE
  87. .sp
  88. Finally, runs of whitespace are normalized to a single ASCII space character\&.
  89. .RE
  90. .PP
  91. \-b
  92. .RS 4
  93. When \-k is not in effect, all leading strings bracketed with
  94. \fI[\fR
  95. and
  96. \fI]\fR
  97. pairs are stripped\&. This option limits the stripping to only the pairs whose bracketed string contains the word "PATCH"\&.
  98. .RE
  99. .PP
  100. \-u
  101. .RS 4
  102. The commit log message, author name and author email are taken from the e\-mail, and after minimally decoding MIME transfer encoding, re\-coded in the charset specified by
  103. \fBi18n\&.commitEncoding\fR
  104. (defaulting to UTF\-8) by transliterating them\&. This used to be optional but now it is the default\&.
  105. .sp
  106. Note that the patch is always used as\-is without charset conversion, even with this flag\&.
  107. .RE
  108. .PP
  109. \-\-encoding=<encoding>
  110. .RS 4
  111. Similar to \-u\&. But when re\-coding, the charset specified here is used instead of the one specified by
  112. \fBi18n\&.commitEncoding\fR
  113. or UTF\-8\&.
  114. .RE
  115. .PP
  116. \-n
  117. .RS 4
  118. Disable all charset re\-coding of the metadata\&.
  119. .RE
  120. .PP
  121. \-m, \-\-message\-id
  122. .RS 4
  123. Copy the Message\-ID header at the end of the commit message\&. This is useful in order to associate commits with mailing list discussions\&.
  124. .RE
  125. .PP
  126. \-\-scissors
  127. .RS 4
  128. Remove everything in body before a scissors line (e\&.g\&. "\-\- >8 \-\-")\&. The line represents scissors and perforation marks, and is used to request the reader to cut the message at that line\&. If that line appears in the body of the message before the patch, everything before it (including the scissors line itself) is ignored when this option is used\&.
  129. .sp
  130. This is useful if you want to begin your message in a discussion thread with comments and suggestions on the message you are responding to, and to conclude it with a patch submission, separating the discussion and the beginning of the proposed commit log message with a scissors line\&.
  131. .sp
  132. This can be enabled by default with the configuration option mailinfo\&.scissors\&.
  133. .RE
  134. .PP
  135. \-\-no\-scissors
  136. .RS 4
  137. Ignore scissors lines\&. Useful for overriding mailinfo\&.scissors settings\&.
  138. .RE
  139. .PP
  140. \-\-quoted\-cr=<action>
  141. .RS 4
  142. Action when processes email messages sent with base64 or quoted\-printable encoding, and the decoded lines end with a CRLF instead of a simple LF\&.
  143. .sp
  144. The valid actions are:
  145. .sp
  146. .RS 4
  147. .ie n \{\
  148. \h'-04'\(bu\h'+03'\c
  149. .\}
  150. .el \{\
  151. .sp -1
  152. .IP \(bu 2.3
  153. .\}
  154. \fBnowarn\fR: Git will do nothing when such a CRLF is found\&.
  155. .RE
  156. .sp
  157. .RS 4
  158. .ie n \{\
  159. \h'-04'\(bu\h'+03'\c
  160. .\}
  161. .el \{\
  162. .sp -1
  163. .IP \(bu 2.3
  164. .\}
  165. \fBwarn\fR: Git will issue a warning for each message if such a CRLF is found\&.
  166. .RE
  167. .sp
  168. .RS 4
  169. .ie n \{\
  170. \h'-04'\(bu\h'+03'\c
  171. .\}
  172. .el \{\
  173. .sp -1
  174. .IP \(bu 2.3
  175. .\}
  176. \fBstrip\fR: Git will convert those CRLF to LF\&.
  177. .RE
  178. .sp
  179. The default action could be set by configuration option
  180. \fBmailinfo\&.quotedCR\fR\&. If no such configuration option has been set,
  181. \fBwarn\fR
  182. will be used\&.
  183. .RE
  184. .PP
  185. <msg>
  186. .RS 4
  187. The commit log message extracted from e\-mail, usually except the title line which comes from e\-mail Subject\&.
  188. .RE
  189. .PP
  190. <patch>
  191. .RS 4
  192. The patch extracted from e\-mail\&.
  193. .RE
  194. .SH "CONFIGURATION"
  195. .sp
  196. Everything below this line in this section is selectively included from the \fBgit-config\fR(1) documentation\&. The content is the same as what\(cqs found there:
  197. .PP
  198. mailinfo\&.scissors
  199. .RS 4
  200. If true, makes
  201. \fBgit-mailinfo\fR(1)
  202. (and therefore
  203. \fBgit-am\fR(1)) act by default as if the \-\-scissors option was provided on the command\-line\&. When active, this feature removes everything from the message body before a scissors line (i\&.e\&. consisting mainly of ">8", "8<" and "\-")\&.
  204. .RE
  205. .SH "GIT"
  206. .sp
  207. Part of the \fBgit\fR(1) suite