Documentation: format-patch
authorJunio C Hamano <junkio@cox.net>
Sat, 5 Nov 2005 10:55:18 +0000 (02:55 -0800)
committerJunio C Hamano <junkio@cox.net>
Sat, 5 Nov 2005 10:55:18 +0000 (02:55 -0800)
Add examples section and talk about using this to cherry-pick
commits.

Signed-off-by: Junio C Hamano <junkio@cox.net>
Documentation/git-format-patch.txt

index f3ef4c1..7a3abec 100644 (file)
@@ -59,6 +59,26 @@ OPTIONS
        standard output, instead of saving them into a file per
        patch and implies --mbox.
 
+
+EXAMPLES
+--------
+
+git-format-patch -k --stdout R1..R2 | git-am -3 -k::
+       Extract commits between revisions R1 and R2, and apply
+       them on top of the current branch using `git-am` to
+       cherry-pick them.
+
+git-format-patch origin::
+       Extract commits the current branch accumulated since it
+       pulled from origin the last time in a patch form for
+       e-mail submission.
+
+
+See Also
+--------
+gitlink:git-am[1], gitlink:git-send-email
+
+
 Author
 ------
 Written by Junio C Hamano <junkio@cox.net>