summaryrefslogtreecommitdiff
path: root/Documentation/git-am.txt
diff options
context:
space:
mode:
authorStephan Beyer <s-beyer@gmx.net>2008-06-08 01:36:09 (GMT)
committerJunio C Hamano <gitster@pobox.com>2008-06-08 20:46:38 (GMT)
commit3240240ff427fa2e26a847c7c9fd89e6a4313daa (patch)
treea1e21579aca42b7e4d8d718050bc522961530cfa /Documentation/git-am.txt
parentbc47c29ec18164ba1f05600333457cf6f2432856 (diff)
downloadgit-3240240ff427fa2e26a847c7c9fd89e6a4313daa.zip
git-3240240ff427fa2e26a847c7c9fd89e6a4313daa.tar.gz
git-3240240ff427fa2e26a847c7c9fd89e6a4313daa.tar.bz2
Docs: Use "-l::\n--long\n" format in OPTIONS sections
The OPTIONS section of a documentation file contains a list of the options a git command accepts. Currently there are several variants to describe the case that different options (almost) do the same in the OPTIONS section. Some are: -f, --foo:: -f|--foo:: -f | --foo:: But AsciiDoc has the special form: -f:: --foo:: This patch applies this form to the documentation of the whole git suite, and removes useless em-dash prevention, so \--foo becomes --foo. Signed-off-by: Stephan Beyer <s-beyer@gmx.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-am.txt')
-rw-r--r--Documentation/git-am.txt24
1 files changed, 16 insertions, 8 deletions
diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt
index 7f6f5b4..46544a0 100644
--- a/Documentation/git-am.txt
+++ b/Documentation/git-am.txt
@@ -28,14 +28,17 @@ OPTIONS
supply this argument, reads from the standard input. If you supply
directories, they'll be treated as Maildirs.
--s, --signoff::
+-s::
+--signoff::
Add `Signed-off-by:` line to the commit message, using
the committer identity of yourself.
--k, --keep::
+-k::
+--keep::
Pass `-k` flag to `git-mailinfo` (see linkgit:git-mailinfo[1]).
--u, --utf8::
+-u::
+--utf8::
Pass `-u` flag to `git-mailinfo` (see linkgit:git-mailinfo[1]).
The proposed commit log message taken from the e-mail
is re-coded into UTF-8 encoding (configuration variable
@@ -49,13 +52,15 @@ default. You could use `--no-utf8` to override this.
Pass `-n` flag to `git-mailinfo` (see
linkgit:git-mailinfo[1]).
--3, --3way::
+-3::
+--3way::
When the patch does not apply cleanly, fall back on
3-way merge, if the patch records the identity of blobs
it is supposed to apply to, and we have those blobs
available locally.
--b, --binary::
+-b::
+--binary::
Pass `--allow-binary-replacement` flag to `git-apply`
(see linkgit:git-apply[1]).
@@ -64,19 +69,22 @@ default. You could use `--no-utf8` to override this.
program that applies
the patch.
--C<n>, -p<n>::
+-C<n>::
+-p<n>::
These flags are passed to the `git-apply` (see linkgit:git-apply[1])
program that applies
the patch.
--i, --interactive::
+-i::
+--interactive::
Run interactively.
--skip::
Skip the current patch. This is only meaningful when
restarting an aborted patch.
--r, --resolved::
+-r::
+--resolved::
After a patch failure (e.g. attempting to apply
conflicting patch), the user has applied it by hand and
the index file stores the result of the application.