kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

Documentation/git-format-patch.txt: Add --signoff, --check, and long option-names. 

The documentation was lacking descriptions for the --signoff and --check
options to git-format-patch.  It was also missing the following long
option-names: --output-directory (-o), --numbered (-n), --keep-subject
(-k), --author (-a), --date (-d), and --mbox (-m).

Signed-off-by: Nikolai Weibull <nikolai@bitwi.se>
Signed-off-by: Junio C Hamano <junkio@cox.net>
maint
Nikolai Weibull 2005-12-09 00:28:05 +01:00 committed by Junio C Hamano
parent d4ce5f7e50
commit 6f855371a5
1 changed files with 17 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
Documentation/git-format-patch.txt
View File

@ -8,7 +8,7 @@ git-format-patch - Prepare patches for e-mail submission.


SYNOPSIS SYNOPSIS
-------- --------
'git-format-patch' [-n][-o <dir>|--stdout][-k][--mbox][--diff-options] <his> [<mine>] 'git-format-patch' [-n | -k] [-o <dir> | --stdout] [-s] [-c] [--mbox] [--diff-options] <his> [<mine>]


DESCRIPTION DESCRIPTION
----------- -----------
@ -32,23 +32,34 @@ processing with applymbox.


OPTIONS OPTIONS
------- -------
-o <dir>:: -o|--output-directory <dir>::
Use <dir> to store the resulting files, instead of the Use <dir> to store the resulting files, instead of the
current working directory. current working directory.


-n:: -n|--numbered::
Name output in '[PATCH n/m]' format. Name output in '[PATCH n/m]' format.


-k:: -k|--keep-subject::
Do not strip/add '[PATCH]' from the first line of the Do not strip/add '[PATCH]' from the first line of the
commit log message. commit log message.


--author, --date:: -a|--author, -d|--date::
Output From: and Date: headers for commits made by Output From: and Date: headers for commits made by
yourself as well. Usually these are output only for yourself as well. Usually these are output only for
commits made by people other than yourself. commits made by people other than yourself.


--mbox:: -s|--signoff::
Add `Signed-off-by:` line to the commit message, using
the committer identity of yourself.

-c|--check::
Display suspicious lines in the patch. The definition
of 'suspicious lines' is currently the lines that has
trailing whitespaces, and the lines whose indentation
has a SP character immediately followed by a TAB
character.

-m|--mbox::
Format the output files for closer to mbox format by Format the output files for closer to mbox format by
adding a phony Unix "From " line, so they can be adding a phony Unix "From " line, so they can be
concatenated together and fed to `git-applymbox`. concatenated together and fed to `git-applymbox`.