git-format-patch.txt: general rewordings and cleanups
Clarify --no-binary description using some words from the original commit 37c22a4b (add --no-binary, 2008-05-9). Cleanup --suffix description. Add --thread style option to synopsis and reorganize it a bit. Clarify renaming patches example and the configuration paragraph. Signed-off-by: Stephen Boyd <bebarino@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Stephen Boyd committed
Apr 23, 2009 at 09:16 UTC
50710ce49b8e66204cc6147345db9c99bb7cfe82
1 file changed
+19
-19
Documentation/git-format-patch.txt
+19
-19
@@ -9,10 +9,10 @@ git-format-patch - Prepare patches for e-mail submission
9
SYNOPSIS
10
--------
11
[verse]
12
-'git format-patch' [-k] [-o <dir> | --stdout] [--thread]
13
- [--attach[=<boundary>] | --inline[=<boundary>] |
14
- [--no-attach]]
15
- [-s | --signoff] [<common diff options>]
12
+'git format-patch' [-k] [(-o|--output-directory) <dir> | --stdout]
13
+ [--thread[=<style>]]
14
+ [(--attach|--inline)[=<boundary>] | --no-attach]
15
+ [-s | --signoff]
16
[-n | --numbered | -N | --no-numbered]
17
[--start-number <n>] [--numbered-files]
18
[--in-reply-to=Message-Id] [--suffix=.<sfx>]
@@ -20,6 +20,7 @@ SYNOPSIS
20
[--subject-prefix=Subject-Prefix]
21
[--cc=<email>]
22
[--cover-letter]
23
+ [<common diff options>]
24
[ <since> | <revision range> ]
25
26
DESCRIPTION
@@ -170,18 +171,17 @@ if that is not set.
171
--suffix=.<sfx>::
172
Instead of using `.patch` as the suffix for generated
173
filenames, use specified suffix. A common alternative is
173
- `--suffix=.txt`.
174
+ `--suffix=.txt`. Leaving this empty will remove the `.patch`
175
+ suffix.
176
+
175
-Note that you would need to include the leading dot `.` if you
176
-want a filename like `0001-description-of-my-change.patch`, and
177
-the first letter does not have to be a dot. Leaving it empty would
178
-not add any suffix.
177
+Note that the leading character does not have to be a dot; for example,
178
+you can use `--suffix=-patch` to get `0001-description-of-my-change-patch`.
179
180
--no-binary::
181
- Don't output contents of changes in binary files, just take note
182
- that they differ. Note that this disable the patch to be properly
183
- applied. By default the contents of changes in those files are
184
- encoded in the patch.
181
+ Do not output contents of changes in binary files, instead
182
+ display a notice that those files changed. Patches generated
183
+ using this option cannot be applied properly, but they are
184
+ still useful for code review.
185
186
--root::
187
Treat the revision argument as a <revision range>, even if it
@@ -192,10 +192,10 @@ not add any suffix.
192
193
CONFIGURATION
194
-------------
195
-You can specify extra mail header lines to be added to each message
196
-in the repository configuration, new defaults for the subject prefix
197
-and file suffix, control attachments, and number patches when outputting
198
-more than one.
195
+You can specify extra mail header lines to be added to each message,
196
+defaults for the subject prefix and file suffix, number patches when
197
+outputting more than one patch, add "Cc:" headers, configure attachments,
198
+and sign off patches with configuration variables.
199
200
------------
201
[format]
@@ -243,8 +243,8 @@ $ git format-patch -M -B origin
243
+
244
Additionally, it detects and handles renames and complete rewrites
245
intelligently to produce a renaming patch. A renaming patch reduces
246
-the amount of text output, and generally makes it easier to review it.
247
-Note that the "patch" program does not understand renaming patches, so
246
+the amount of text output, and generally makes it easier to review.
247
+Note that non-git "patch" programs won't understand renaming patches, so
248
use it only when you know the recipient uses git to apply your patch.
249
250
* Extract three topmost commits from the current branch and format them