SubmittingPatches: document how to reference previous commits
[gitweb.git] / Documentation / git-mailsplit.txt
index 5a17801f6a8d4d307f55e62745a400ad498ebdb9..4d1b871d96177ca36e7fadd115685316292dc727 100644 (file)
@@ -3,16 +3,20 @@ git-mailsplit(1)
 
 NAME
 ----
-git-mailsplit - Totally braindamaged mbox splitter program
+git-mailsplit - Simple UNIX mbox splitter program
 
 SYNOPSIS
 --------
-'git-mailsplit' [-b] [-f<nn>] [-d<prec>] -o<directory> [--] [<mbox>...]
+[verse]
+'git mailsplit' [-b] [-f<nn>] [-d<prec>] [--keep-cr] -o<directory> [--] [(<mbox>|<Maildir>)...]
 
 DESCRIPTION
 -----------
-Splits a mbox file into a list of files: "0001" "0002" ..  in the specified
-directory so you can process them further from there.
+Splits a mbox file or a Maildir into a list of files: "0001" "0002" ..  in the
+specified directory so you can process them further from there.
+
+IMPORTANT: Maildir splitting relies upon filenames being sorted to output
+patches in the correct order.
 
 OPTIONS
 -------
@@ -20,7 +24,11 @@ OPTIONS
        Mbox file to split.  If not given, the mbox is read from
        the standard input.
 
-<directory>::
+<Maildir>::
+       Root of the Maildir to split. This directory should contain the cur, tmp
+       and new subdirectories.
+
+-o<directory>::
        Directory in which to place the individual messages.
 
 -b::
@@ -36,17 +44,9 @@ OPTIONS
        Skip the first <nn> numbers, for example if -f3 is specified,
        start the numbering with 0004.
 
-Author
-------
-Written by Linus Torvalds <torvalds@osdl.org>
-and Junio C Hamano <junkio@cox.net>
-
-
-Documentation
---------------
-Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
+--keep-cr::
+       Do not remove `\r` from lines ending with `\r\n`.
 
 GIT
 ---
-Part of the gitlink:git[7] suite
-
+Part of the linkgit:git[1] suite