git-commit-vandalism/Documentation/git-format-patch.txt
Junio C Hamano 35ef3a4c63 Documentation updates.
Fill in more missing documentation.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-07 23:04:52 -07:00

70 lines
1.7 KiB
Plaintext

git-format-patch(1)
===================
NAME
----
git-format-patch - Prepare patches for e-mail submission.
SYNOPSIS
--------
'git-format-patch' [-n][-o <dir>][-k][--mbox][--diff-options] <his> [<mine>]
DESCRIPTION
-----------
Prepare each commit with its patch since <mine> head forked from
<his> head, one file per patch, for e-mail submission. Each
output file is numbered sequentially from 1, and uses the first
line of the commit message (massaged for pathname safety) as the
filename.
When -o is specified, output files are created in that
directory; otherwise in the current working directory.
When -n is specified, instead of "[PATCH] Subject", the first
line is formatted as "[PATCH N/M] Subject", unless you have only
one patch.
When --mbox is specified, the output is formatted to resemble
UNIX mailbox format, and can be concatenated together for
processing with applymbox.
OPTIONS
-------
-o <dir>::
Use <dir> to store the resulting files, instead of the
current working directory.
-n::
Name output in '[PATCH n/m]' format.
-k::
Do not strip/add '[PATCH]' from the first line of the
commit log message.
--author, --date::
Output From: and Date: headers for commits made by
yourself as well. Usually these are output only for
commits made by people other than yourself.
--mbox::
Format the output files for closer to mbox format by
adding a phony Unix "From " line, so they can be
concatenated together and fed to `git-applymbox`.
Implies --author and --date.
Author
------
Written by Junio C Hamano <junkio@cox.net>
Documentation
--------------
Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
GIT
---
Part of the link:git.html[git] suite