mirror of
https://github.com/git/git.git
synced 2026-03-05 06:57:37 +01:00
doc: am: normalize git(1) command links
There are many mentions of commands using inline-verbatim or
emphasis ('). We just mention the command themselves, not specific
invocations like `git am <opts>`. Let’s link to them instead.
There are also many such mentions which then link to the command right
afterwards. Simplify to just using a link.
Also remove “see <gitlink>” phrases where they have now already
been mentioned.
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
committed by
Junio C Hamano
parent
9a2fb147f2
commit
b679ee0422
@@ -1,14 +1,14 @@
|
||||
am.keepcr::
|
||||
If true, git-am will call git-mailsplit for patches in mbox format
|
||||
with parameter `--keep-cr`. In this case git-mailsplit will
|
||||
If true, linkgit:git-am[1] will call linkgit:git-mailsplit[1]
|
||||
for patches in mbox format with parameter `--keep-cr`. In this
|
||||
case linkgit:git-mailsplit[1] will
|
||||
not remove `\r` from lines ending with `\r\n`. Can be overridden
|
||||
by giving `--no-keep-cr` from the command line.
|
||||
See linkgit:git-am[1], linkgit:git-mailsplit[1].
|
||||
|
||||
am.threeWay::
|
||||
By default, `git am` will fail if the patch does not apply cleanly. When
|
||||
set to true, this setting tells `git am` to 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 (equivalent to giving the `--3way`
|
||||
option from the command line). Defaults to `false`.
|
||||
See linkgit:git-am[1].
|
||||
By default, linkgit:git-am[1] will fail if the patch does not
|
||||
apply cleanly. When set to true, this setting tells
|
||||
linkgit:git-am[1] to 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 (equivalent to giving the
|
||||
`--3way` option from the command line). Defaults to `false`.
|
||||
|
||||
@@ -43,14 +43,14 @@ OPTIONS
|
||||
|
||||
-k::
|
||||
--keep::
|
||||
Pass `-k` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).
|
||||
Pass `-k` flag to linkgit:git-mailinfo[1].
|
||||
|
||||
--keep-non-patch::
|
||||
Pass `-b` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).
|
||||
Pass `-b` flag to linkgit:git-mailinfo[1].
|
||||
|
||||
--keep-cr::
|
||||
--no-keep-cr::
|
||||
With `--keep-cr`, call 'git mailsplit' (see linkgit:git-mailsplit[1])
|
||||
With `--keep-cr`, call linkgit:git-mailsplit[1]
|
||||
with the same option, to prevent it from stripping CR at the end of
|
||||
lines. `am.keepcr` configuration variable can be used to specify the
|
||||
default behaviour. `--no-keep-cr` is useful to override `am.keepcr`.
|
||||
@@ -65,7 +65,7 @@ OPTIONS
|
||||
Ignore scissors lines (see linkgit:git-mailinfo[1]).
|
||||
|
||||
--quoted-cr=<action>::
|
||||
This flag will be passed down to 'git mailinfo' (see linkgit:git-mailinfo[1]).
|
||||
This flag will be passed down to linkgit:git-mailinfo[1].
|
||||
|
||||
--empty=(drop|keep|stop)::
|
||||
How to handle an e-mail message lacking a patch:
|
||||
@@ -83,7 +83,7 @@ OPTIONS
|
||||
|
||||
-m::
|
||||
--message-id::
|
||||
Pass the `-m` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]),
|
||||
Pass the `-m` flag to linkgit:git-mailinfo[1],
|
||||
so that the Message-ID header is added to the commit message.
|
||||
The `am.messageid` configuration variable can be used to specify
|
||||
the default behaviour.
|
||||
@@ -98,7 +98,7 @@ OPTIONS
|
||||
|
||||
-u::
|
||||
--utf8::
|
||||
Pass `-u` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).
|
||||
Pass `-u` flag to linkgit:git-mailinfo[1].
|
||||
The proposed commit log message taken from the e-mail
|
||||
is re-coded into UTF-8 encoding (configuration variable
|
||||
`i18n.commitEncoding` can be used to specify the project's
|
||||
@@ -108,8 +108,7 @@ This was optional in prior versions of git, but now it is the
|
||||
default. You can use `--no-utf8` to override this.
|
||||
|
||||
--no-utf8::
|
||||
Pass `-n` flag to 'git mailinfo' (see
|
||||
linkgit:git-mailinfo[1]).
|
||||
Pass `-n` flag to linkgit:git-mailinfo[1].
|
||||
|
||||
-3::
|
||||
--3way::
|
||||
@@ -132,9 +131,8 @@ include::rerere-options.adoc[]
|
||||
--exclude=<path>::
|
||||
--include=<path>::
|
||||
--reject::
|
||||
These flags are passed to the 'git apply' (see linkgit:git-apply[1])
|
||||
program that applies
|
||||
the patch.
|
||||
These flags are passed to the linkgit:git-apply[1] program that
|
||||
applies the patch.
|
||||
+
|
||||
Valid <action> for the `--whitespace` option are:
|
||||
`nowarn`, `warn`, `fix`, `error`, and `error-all`.
|
||||
@@ -198,7 +196,8 @@ Valid <action> for the `--whitespace` option are:
|
||||
to the screen before exiting. This overrides the
|
||||
standard message informing you to use `--continue`
|
||||
or `--skip` to handle the failure. This is solely
|
||||
for internal use between 'git rebase' and 'git am'.
|
||||
for internal use between linkgit:git-rebase[1] and
|
||||
linkgit:git-am[1].
|
||||
|
||||
--abort::
|
||||
Restore the original branch and abort the patching operation.
|
||||
@@ -216,7 +215,7 @@ Valid <action> for the `--whitespace` option are:
|
||||
failure again.
|
||||
|
||||
--show-current-patch[=(diff|raw)]::
|
||||
Show the message at which `git am` has stopped due to
|
||||
Show the message at which linkgit:git-am[1] has stopped due to
|
||||
conflicts. If `raw` is specified, show the raw contents of
|
||||
the e-mail message; if `diff`, show the diff portion only.
|
||||
Defaults to `raw`.
|
||||
@@ -254,7 +253,7 @@ message. Any line that is of the form:
|
||||
is taken as the beginning of a patch, and the commit log message
|
||||
is terminated before the first occurrence of such a line.
|
||||
|
||||
When initially invoking `git am`, you give it the names of the mailboxes
|
||||
When initially invoking linkgit:git-am[1], you give it the names of the mailboxes
|
||||
to process. Upon seeing the first patch that does not apply, it
|
||||
aborts in the middle. You can recover from this in one of two ways:
|
||||
|
||||
@@ -272,8 +271,8 @@ names.
|
||||
|
||||
Before any patches are applied, ORIG_HEAD is set to the tip of the
|
||||
current branch. This is useful if you have problems with multiple
|
||||
commits, like running 'git am' on the wrong branch or an error in the
|
||||
commits that is more easily fixed by changing the mailbox (e.g.
|
||||
commits, like running linkgit:git-am[1] on the wrong branch or an error
|
||||
in the commits that is more easily fixed by changing the mailbox (e.g.
|
||||
errors in the "From:" lines).
|
||||
|
||||
HOOKS
|
||||
|
||||
Reference in New Issue
Block a user