diff options
| author | Junio C Hamano <junkio@cox.net> | 2005-08-29 17:21:06 -0700 |
|---|---|---|
| committer | Junio C Hamano <junkio@cox.net> | 2005-08-29 17:21:06 -0700 |
| commit | f85a41916163097c3c307ac45d1a935564c52bf0 (patch) | |
| tree | aacced7340195bb8416a5c4f76e8bfac2d68dc73 /Documentation/git-mailinfo.txt | |
| parent | d5acdcf18e255308f5f16ae9e7fe48bf21ff68c0 (diff) | |
| download | git-f85a41916163097c3c307ac45d1a935564c52bf0.tar.gz git-f85a41916163097c3c307ac45d1a935564c52bf0.tar.xz | |
Accumulated documentation updates.
Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation/git-mailinfo.txt')
| -rw-r--r-- | Documentation/git-mailinfo.txt | 43 |
1 files changed, 35 insertions, 8 deletions
diff --git a/Documentation/git-mailinfo.txt b/Documentation/git-mailinfo.txt index b75f61c84..eb3a3d1be 100644 --- a/Documentation/git-mailinfo.txt +++ b/Documentation/git-mailinfo.txt @@ -3,30 +3,57 @@ git-mailinfo(1) NAME ---- -git-mailinfo - Some git command not yet documented. +git-mailinfo - Extracts patch from a single e-mail message. SYNOPSIS -------- -'git-mailinfo' [ --option ] <args>... +'git-mailinfo' [-k] [-u] <msg> <patch> + DESCRIPTION ----------- -Does something not yet documented. +Reading 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 git-applypatch +to create a commit. It is usually not necessary to use this +command directly. OPTIONS ------- ---option:: - Some option not yet documented. +-k:: + Usually the program 'cleans up' the Subject: header line + to extract the title line for the commit log message, + among which (1) remove 'Re:' or 're:', (2) leading + whitespaces, (3) '[' up to ']', typically '[PATCH]', and + then prepends "[PATCH] ". This flag forbids this + munging, and is most useful when used to read back 'git + format-patch --mbox' output. + +-u:: + By default, the commit log message, author name and + author email are taken from the e-mail without any + charset conversion, after minimally decoding MIME + transfer encoding. This flag causes the resulting + commit to be encoded in utf-8 by transliterating them. + Note that the patch is always used as is without charset + conversion, even with this flag. -<args>...:: - Some argument not yet documented. +<msg>:: + The commit log message extracted from e-mail, usually + except the title line which comes from e-mail Subject. + +<patch>:: + The patch extracted from e-mail. Author ------ -Written by Linus Torvalds <torvalds@osdl.org> +Written by Linus Torvalds <torvalds@osdl.org> and +Junio C Hamano <junkio@cox.net> + Documentation -------------- |