undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

git-am: Clean up the asciidoc documentation

Browse Source 
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>
This commit is contained in:
Frank Lichtenheld 2007-05-14 16:44:53 +02:00 committed by Junio C Hamano
parent 7b1885d1e7
commit 870e0d61d3
1 changed files with 24 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
Documentation/git-am.txt
View File

@ -9,8 +9,9 @@ git-am - Apply a series of patches from a mailbox
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'git-am' [--signoff] [--dotest=<dir>] [--utf8 | --no-utf8] [--binary] [--3way] 'git-am' [--signoff] [--dotest=<dir>] [--keep] [--utf8 | --no-utf8]
[--interactive] [--whitespace=<option>] [-C<n>] [-p<n>] [--3way] [--interactive] [--binary]
[--whitespace=<option>] [-C<n>] [-p<n>]
<mbox>... <mbox>...
'git-am' [--skip | --resolved] 'git-am' [--skip | --resolved]
@ -40,7 +41,7 @@ OPTIONS
-u, --utf8:: -u, --utf8::
Pass `-u` flag to `git-mailinfo` (see gitlink:git-mailinfo[1]). Pass `-u` flag to `git-mailinfo` (see gitlink:git-mailinfo[1]).
The proposed commit log message taken from the e-mail The proposed commit log message taken from the e-mail
are re-coded into UTF-8 encoding (configuration variable is re-coded into UTF-8 encoding (configuration variable
`i18n.commitencoding` can be used to specify project's `i18n.commitencoding` can be used to specify project's
preferred encoding if it is not UTF-8). preferred encoding if it is not UTF-8).
+ +
@ -51,31 +52,33 @@ default. You could use `--no-utf8` to override this.
Pass `-n` flag to `git-mailinfo` (see Pass `-n` flag to `git-mailinfo` (see
gitlink:git-mailinfo[1]). gitlink:git-mailinfo[1]).
-b, --binary::
Pass `--allow-binary-replacement` flag to `git-apply`
(see gitlink:git-apply[1]).
-3, --3way:: -3, --3way::
When the patch does not apply cleanly, fall back on When the patch does not apply cleanly, fall back on
3-way merge, if the patch records the identity of blobs 3-way merge, if the patch records the identity of blobs
it is supposed to apply to, and we have those blobs it is supposed to apply to, and we have those blobs
locally. available locally.
-b, --binary::
Pass `--allow-binary-replacement` flag to `git-apply`
(see gitlink:git-apply[1]).
--whitespace=<option>::
This flag is passed to the `git-apply` (see gitlink:git-apply[1])
program that applies
the patch.
-C<n>, -p<n>::
These flags are passed to the `git-apply` (see gitlink:git-apply[1])
program that applies
the patch.
-i, --interactive::
Run interactively.
--skip:: --skip::
Skip the current patch. This is only meaningful when Skip the current patch. This is only meaningful when
restarting an aborted patch. restarting an aborted patch.
--whitespace=<option>::
This flag is passed to the `git-apply` program that applies
the patch.
-C<n>, -p<n>::
These flags are passed to the `git-apply` program that applies
the patch.
-i, --interactive::
Run interactively, just like git-applymbox.
-r, --resolved:: -r, --resolved::
After a patch failure (e.g. attempting to apply After a patch failure (e.g. attempting to apply
conflicting patch), the user has applied it by hand and conflicting patch), the user has applied it by hand and
@ -126,7 +129,7 @@ to crunch. Upon seeing the first patch that does not apply, it
aborts in the middle, just like 'git-applymbox' does. You can aborts in the middle, just like 'git-applymbox' does. You can
recover from this in one of two ways: recover from this in one of two ways:
. skip the current one by re-running the command with '--skip' . skip the current patch by re-running the command with '--skip'
option. option.
. hand resolve the conflict in the working directory, and update . hand resolve the conflict in the working directory, and update