X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fgit-mailinfo.txt;h=996c3fcc6cde0b7ce1acf6bfb3815bac4dd6176c;hb=b48275998399561780af85d429da3caceeecd2fe;hp=0b23faee7a431f6b68056a1517a099c9689fc56e;hpb=438d2991eaa17549df67929cd4558d65840c37d7;p=git.git diff --git a/Documentation/git-mailinfo.txt b/Documentation/git-mailinfo.txt index 0b23faee7..996c3fcc6 100644 --- a/Documentation/git-mailinfo.txt +++ b/Documentation/git-mailinfo.txt @@ -8,15 +8,15 @@ git-mailinfo - Extracts patch and authorship from a single e-mail message SYNOPSIS -------- -'git-mailinfo' [-k] [-u | --encoding= | -n] +'git mailinfo' [-k] [-u | --encoding= | -n] [--scissors] DESCRIPTION ----------- -Reading a single e-mail message from the standard input, and +Reads 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-am +written out to the standard output to be used by 'git-am' to create a commit. It is usually not necessary to use this command directly. See linkgit:git-am[1] instead. @@ -29,8 +29,8 @@ OPTIONS 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 -k' output. + munging, and is most useful when used to read back + 'git-format-patch -k' output. -u:: The commit log message, author name and author email are @@ -49,6 +49,25 @@ conversion, even with this flag. -n:: Disable all charset re-coding of the metadata. +--scissors:: + Remove everything in body before a scissors line. A line that + mainly consists of scissors (either ">8" or "8<") and perforation + (dash "-") marks is called a scissors line, and is used to request + the reader to cut the message at that line. If such a 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. ++ +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. ++ +This can enabled by default with the configuration option mailinfo.scissors. + +--no-scissors:: + Ignore scissors lines. Useful for overriding mailinfo.scissors settings. + :: The commit log message extracted from e-mail, usually except the title line which comes from e-mail Subject.