git-am: Clean up the asciidoc documentation
Add --keep to synopsis. The synopsys used a mix of tabs and spaces, unify to use only spaces. Shuffle options around in synopsys and description for grouping them logically. Add more gitlink references to other commands. Various grammatical fixes and improvements. Signed-off-by: Frank Lichtenheld <frank@lichtenheld.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
Frank Lichtenheld committed
May 14, 2007 at 16:44 UTC
870e0d61d30a943dc050a67574f3f32faff226db
1 file changed
+19
-16
Documentation/git-am.txt
+19
-16
@@ -9,9 +9,10 @@ git-am - Apply a series of patches from a mailbox
9
SYNOPSIS
10
--------
11
[verse]
12
-'git-am' [--signoff] [--dotest=<dir>] [--utf8 | --no-utf8] [--binary] [--3way]
13
- [--interactive] [--whitespace=<option>] [-C<n>] [-p<n>]
14
- <mbox>...
12
+'git-am' [--signoff] [--dotest=<dir>] [--keep] [--utf8 | --no-utf8]
13
+ [--3way] [--interactive] [--binary]
14
+ [--whitespace=<option>] [-C<n>] [-p<n>]
15
+ <mbox>...
16
'git-am' [--skip | --resolved]
17
18
DESCRIPTION
@@ -40,7 +41,7 @@ OPTIONS
41
-u, --utf8::
42
Pass `-u` flag to `git-mailinfo` (see gitlink:git-mailinfo[1]).
43
The proposed commit log message taken from the e-mail
43
- are re-coded into UTF-8 encoding (configuration variable
44
+ is re-coded into UTF-8 encoding (configuration variable
45
`i18n.commitencoding` can be used to specify project's
46
preferred encoding if it is not UTF-8).
47
+
@@ -51,30 +52,32 @@ default. You could use `--no-utf8` to override this.
52
Pass `-n` flag to `git-mailinfo` (see
53
gitlink:git-mailinfo[1]).
54
54
--b, --binary::
55
- Pass `--allow-binary-replacement` flag to `git-apply`
56
- (see gitlink:git-apply[1]).
57
-
55
-3, --3way::
56
When the patch does not apply cleanly, fall back on
57
3-way merge, if the patch records the identity of blobs
58
it is supposed to apply to, and we have those blobs
62
- locally.
59
+ available locally.
60
64
---skip::
65
- Skip the current patch. This is only meaningful when
66
- restarting an aborted patch.
61
+-b, --binary::
62
+ Pass `--allow-binary-replacement` flag to `git-apply`
63
+ (see gitlink:git-apply[1]).
64
65
--whitespace=<option>::
69
- This flag is passed to the `git-apply` program that applies
66
+ This flag is passed to the `git-apply` (see gitlink:git-apply[1])
67
+ program that applies
68
the patch.
69
70
-C<n>, -p<n>::
73
- These flags are passed to the `git-apply` program that applies
71
+ These flags are passed to the `git-apply` (see gitlink:git-apply[1])
72
+ program that applies
73
the patch.
74
75
-i, --interactive::
77
- Run interactively, just like git-applymbox.
76
+ Run interactively.
77
+
78
+--skip::
79
+ Skip the current patch. This is only meaningful when
80
+ restarting an aborted patch.
81
82
-r, --resolved::
83
After a patch failure (e.g. attempting to apply
@@ -126,7 +129,7 @@ to crunch. Upon seeing the first patch that does not apply, it
129
aborts in the middle, just like 'git-applymbox' does. You can
130
recover from this in one of two ways:
131
129
-. skip the current one by re-running the command with '--skip'
132
+. skip the current patch by re-running the command with '--skip'
133
option.
134
135
. hand resolve the conflict in the working directory, and update