Skip to content

Commit 66f04f3

Browse files
agericJunio C Hamano
authored andcommitted
format-patch: Remove last vestiges of --mbox option
Don't mention it in docs or --help output. Remove mbox, date and author variables from git-format-patch.sh. Use DESCRIPTION text from man-page to update LONG_USAGE output. It's a bit silly to have two texts saying the same thing in different words, and I'm too lazy to update both. Signed-off-by: Andreas Ericsson <ae@op5.se> Signed-off-by: Junio C Hamano <junkio@cox.net>
1 parent 90768da commit 66f04f3

File tree

2 files changed

+25
-37
lines changed

2 files changed

+25
-37
lines changed

Documentation/git-format-patch.txt

Lines changed: 10 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -9,28 +9,27 @@ git-format-patch - Prepare patches for e-mail submission.
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git-format-patch' [-n | -k] [-o <dir> | --stdout] [-s] [-c] [--mbox]
12+
'git-format-patch' [-n | -k] [-o <dir> | --stdout] [-s] [-c]
1313
[--diff-options] <his> [<mine>]
1414

1515
DESCRIPTION
1616
-----------
1717
Prepare each commit with its patch since <mine> head forked from
18-
<his> head, one file per patch, for e-mail submission. Each
19-
output file is numbered sequentially from 1, and uses the first
20-
line of the commit message (massaged for pathname safety) as the
21-
filename.
18+
<his> head, one file per patch formatted to resemble UNIX mailbox
19+
format, for e-mail submission or use with gitlink:git-am[1].
2220

23-
When -o is specified, output files are created in that
24-
directory; otherwise in the current working directory.
21+
Each output file is numbered sequentially from 1, and uses the
22+
first line of the commit message (massaged for pathname safety)
23+
as the filename.
24+
25+
When -o is specified, output files are created in <dir>; otherwise
26+
they are created in the current working directory. This option
27+
is ignored if --stdout is specified.
2528

2629
When -n is specified, instead of "[PATCH] Subject", the first
2730
line is formatted as "[PATCH N/M] Subject", unless you have only
2831
one patch.
2932

30-
When --mbox is specified, the output is formatted to resemble
31-
UNIX mailbox format, and can be concatenated together for
32-
processing with applymbox.
33-
3433

3534
OPTIONS
3635
-------
@@ -45,11 +44,6 @@ OPTIONS
4544
Do not strip/add '[PATCH]' from the first line of the
4645
commit log message.
4746

48-
-a|--author, -d|--date::
49-
Output From: and Date: headers for commits made by
50-
yourself as well. Usually these are output only for
51-
commits made by people other than yourself.
52-
5347
-s|--signoff::
5448
Add `Signed-off-by:` line to the commit message, using
5549
the committer identity of yourself.
@@ -61,12 +55,6 @@ OPTIONS
6155
has a SP character immediately followed by a TAB
6256
character.
6357

64-
-m|--mbox::
65-
Format the output files for closer to mbox format by
66-
adding a phony Unix "From " line, so they can be
67-
concatenated together and fed to `git-applymbox`.
68-
Implies --author and --date.
69-
7058
--stdout::
7159
This flag generates the mbox formatted output to the
7260
standard output, instead of saving them into a file per

git-format-patch.sh

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,23 @@
33
# Copyright (c) 2005 Junio C Hamano
44
#
55

6-
USAGE='[-n | -k] [-o <dir> | --stdout] [--signoff] [--check] [--mbox] [--diff-options] <upstream> [<our-head>]'
7-
LONG_USAGE='Prepare each commit with its patch since our-head forked from upstream,
8-
one file per patch, for e-mail submission. Each output file is
9-
numbered sequentially from 1, and uses the first line of the commit
10-
message (massaged for pathname safety) as the filename.
6+
USAGE='[-n | -k] [-o <dir> | --stdout] [--signoff] [--check] [--diff-options] <his> [<mine>]'
7+
LONG_USAGE='Prepare each commit with its patch since <mine> head forked from
8+
<his> head, one file per patch formatted to resemble UNIX mailbox
9+
format, for e-mail submission or use with git-am.
1110
12-
There are three output modes. By default, output files are created in
13-
the current working directory; when -o is specified, they are created
14-
in that directory instead; when --stdout is specified, they are spit
15-
on standard output, and can be piped to git-am.
11+
Each output file is numbered sequentially from 1, and uses the
12+
first line of the commit message (massaged for pathname safety)
13+
as the filename.
1614
17-
When -n is specified, instead of "[PATCH] Subject", the first line is formatted
18-
as "[PATCH N/M] Subject", unless you have only one patch.
15+
When -o is specified, output files are created in <dir>; otherwise
16+
they are created in the current working directory. This option
17+
is ignored if --stdout is specified.
18+
19+
When -n is specified, instead of "[PATCH] Subject", the first
20+
line is formatted as "[PATCH N/M] Subject", unless you have only
21+
one patch.'
1922

20-
When --mbox is specified, the output is formatted to resemble
21-
UNIX mailbox format, and can be concatenated together for processing
22-
with applymbox.'
2323
. git-sh-setup
2424

2525
# Force diff to run in C locale.
@@ -48,7 +48,7 @@ do
4848
-s|--s|--si|--sig|--sign|--signo|--signof|--signoff)
4949
signoff=t ;;
5050
--st|--std|--stdo|--stdou|--stdout)
51-
stdout=t mbox=t date=t author=t ;;
51+
stdout=t ;;
5252
-o=*|--o=*|--ou=*|--out=*|--outp=*|--outpu=*|--output=*|--output-=*|\
5353
--output-d=*|--output-di=*|--output-dir=*|--output-dire=*|\
5454
--output-direc=*|--output-direct=*|--output-directo=*|\

0 commit comments

Comments
 (0)