Skip to content

Commit b679ee0

Browse files
LemmingAvalanchegitster
authored andcommitted
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>
1 parent 9a2fb14 commit b679ee0

File tree

2 files changed

+24
-25
lines changed

2 files changed

+24
-25
lines changed

Documentation/config/am.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
am.keepcr::
2-
If true, git-am will call git-mailsplit for patches in mbox format
3-
with parameter `--keep-cr`. In this case git-mailsplit will
2+
If true, linkgit:git-am[1] will call linkgit:git-mailsplit[1]
3+
for patches in mbox format with parameter `--keep-cr`. In this
4+
case linkgit:git-mailsplit[1] will
45
not remove `\r` from lines ending with `\r\n`. Can be overridden
56
by giving `--no-keep-cr` from the command line.
6-
See linkgit:git-am[1], linkgit:git-mailsplit[1].
77

88
am.threeWay::
9-
By default, `git am` will fail if the patch does not apply cleanly. When
10-
set to true, this setting tells `git am` to fall back on 3-way merge if
11-
the patch records the identity of blobs it is supposed to apply to and
12-
we have those blobs available locally (equivalent to giving the `--3way`
13-
option from the command line). Defaults to `false`.
14-
See linkgit:git-am[1].
9+
By default, linkgit:git-am[1] will fail if the patch does not
10+
apply cleanly. When set to true, this setting tells
11+
linkgit:git-am[1] to fall back on 3-way merge if the patch
12+
records the identity of blobs it is supposed to apply to and we
13+
have those blobs available locally (equivalent to giving the
14+
`--3way` option from the command line). Defaults to `false`.

Documentation/git-am.adoc

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,14 @@ OPTIONS
4343

4444
-k::
4545
--keep::
46-
Pass `-k` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).
46+
Pass `-k` flag to linkgit:git-mailinfo[1].
4747

4848
--keep-non-patch::
49-
Pass `-b` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).
49+
Pass `-b` flag to linkgit:git-mailinfo[1].
5050

5151
--keep-cr::
5252
--no-keep-cr::
53-
With `--keep-cr`, call 'git mailsplit' (see linkgit:git-mailsplit[1])
53+
With `--keep-cr`, call linkgit:git-mailsplit[1]
5454
with the same option, to prevent it from stripping CR at the end of
5555
lines. `am.keepcr` configuration variable can be used to specify the
5656
default behaviour. `--no-keep-cr` is useful to override `am.keepcr`.
@@ -65,7 +65,7 @@ OPTIONS
6565
Ignore scissors lines (see linkgit:git-mailinfo[1]).
6666

6767
--quoted-cr=<action>::
68-
This flag will be passed down to 'git mailinfo' (see linkgit:git-mailinfo[1]).
68+
This flag will be passed down to linkgit:git-mailinfo[1].
6969

7070
--empty=(drop|keep|stop)::
7171
How to handle an e-mail message lacking a patch:
@@ -83,7 +83,7 @@ OPTIONS
8383

8484
-m::
8585
--message-id::
86-
Pass the `-m` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]),
86+
Pass the `-m` flag to linkgit:git-mailinfo[1],
8787
so that the Message-ID header is added to the commit message.
8888
The `am.messageid` configuration variable can be used to specify
8989
the default behaviour.
@@ -98,7 +98,7 @@ OPTIONS
9898

9999
-u::
100100
--utf8::
101-
Pass `-u` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).
101+
Pass `-u` flag to linkgit:git-mailinfo[1].
102102
The proposed commit log message taken from the e-mail
103103
is re-coded into UTF-8 encoding (configuration variable
104104
`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
108108
default. You can use `--no-utf8` to override this.
109109

110110
--no-utf8::
111-
Pass `-n` flag to 'git mailinfo' (see
112-
linkgit:git-mailinfo[1]).
111+
Pass `-n` flag to linkgit:git-mailinfo[1].
113112

114113
-3::
115114
--3way::
@@ -132,9 +131,8 @@ include::rerere-options.adoc[]
132131
--exclude=<path>::
133132
--include=<path>::
134133
--reject::
135-
These flags are passed to the 'git apply' (see linkgit:git-apply[1])
136-
program that applies
137-
the patch.
134+
These flags are passed to the linkgit:git-apply[1] program that
135+
applies the patch.
138136
+
139137
Valid <action> for the `--whitespace` option are:
140138
`nowarn`, `warn`, `fix`, `error`, and `error-all`.
@@ -198,7 +196,8 @@ Valid <action> for the `--whitespace` option are:
198196
to the screen before exiting. This overrides the
199197
standard message informing you to use `--continue`
200198
or `--skip` to handle the failure. This is solely
201-
for internal use between 'git rebase' and 'git am'.
199+
for internal use between linkgit:git-rebase[1] and
200+
linkgit:git-am[1].
202201

203202
--abort::
204203
Restore the original branch and abort the patching operation.
@@ -216,7 +215,7 @@ Valid <action> for the `--whitespace` option are:
216215
failure again.
217216

218217
--show-current-patch[=(diff|raw)]::
219-
Show the message at which `git am` has stopped due to
218+
Show the message at which linkgit:git-am[1] has stopped due to
220219
conflicts. If `raw` is specified, show the raw contents of
221220
the e-mail message; if `diff`, show the diff portion only.
222221
Defaults to `raw`.
@@ -254,7 +253,7 @@ message. Any line that is of the form:
254253
is taken as the beginning of a patch, and the commit log message
255254
is terminated before the first occurrence of such a line.
256255

257-
When initially invoking `git am`, you give it the names of the mailboxes
256+
When initially invoking linkgit:git-am[1], you give it the names of the mailboxes
258257
to process. Upon seeing the first patch that does not apply, it
259258
aborts in the middle. You can recover from this in one of two ways:
260259

@@ -272,8 +271,8 @@ names.
272271

273272
Before any patches are applied, ORIG_HEAD is set to the tip of the
274273
current branch. This is useful if you have problems with multiple
275-
commits, like running 'git am' on the wrong branch or an error in the
276-
commits that is more easily fixed by changing the mailbox (e.g.
274+
commits, like running linkgit:git-am[1] on the wrong branch or an error
275+
in the commits that is more easily fixed by changing the mailbox (e.g.
277276
errors in the "From:" lines).
278277

279278
HOOKS

0 commit comments

Comments
 (0)