X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=Documentation%2Fgit-mailinfo.txt;h=dc7d725ea155f9eccb7ebab7df6335ae7589d483;hb=cb22bc44474686f1e0d1ad991732ccd634498729;hp=b75f61c84ce07946cad2344502e0a823575d8c9c;hpb=58eaf287f1b25f6427b06bd72d8e555615828aeb;p=git.git diff --git a/Documentation/git-mailinfo.txt b/Documentation/git-mailinfo.txt index b75f61c8..dc7d725e 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 ] ... +'git-mailinfo' [-k] [-u] + DESCRIPTION ----------- -Does something not yet documented. +Reading a single e-mail message from the standard input, and +writes the commit log message in file, and the patches in + 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. -...:: - Some argument not yet documented. +:: + The commit log message extracted from e-mail, usually + except the title line which comes from e-mail Subject. + +:: + The patch extracted from e-mail. Author ------ -Written by Linus Torvalds +Written by Linus Torvalds and +Junio C Hamano + Documentation -------------- @@ -34,5 +61,5 @@ Documentation by Junio C Hamano and the git-list . GIT --- -Part of the link:git.html[git] suite +Part of the gitlink:git[7] suite