Skip to content

Commit 0cb25d1

Browse files
committed
Merge branch 'ja/doc-formatting-fix'
Documentation mark-up fix. * ja/doc-formatting-fix: doc: fix some placeholders formating doc: format alternatives in synopsis
2 parents a7f0fcb + 67471bc commit 0cb25d1

File tree

8 files changed

+17
-15
lines changed

8 files changed

+17
-15
lines changed

Documentation/fetch-options.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ endif::git-pull[]
202202
destination of an explicit refspec; see `--prune`).
203203

204204
ifndef::git-pull[]
205-
--recurse-submodules[=yes|on-demand|no]::
205+
--recurse-submodules[=(yes|on-demand|no)]::
206206
This option controls if and under what conditions new commits of
207207
submodules should be fetched too. When recursing through submodules,
208208
`git fetch` always attempts to fetch "changed" submodules, that is, a

Documentation/git-interpret-trailers.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ SYNOPSIS
99
--------
1010
[verse]
1111
'git interpret-trailers' [--in-place] [--trim-empty]
12-
[(--trailer (<key>|<keyAlias>)[(=|:)<value>])...]
12+
[(--trailer (<key>|<key-alias>)[(=|:)<value>])...]
1313
[--parse] [<file>...]
1414

1515
DESCRIPTION
@@ -67,9 +67,9 @@ key: value
6767
This means that the trimmed <key> and <value> will be separated by
6868
`': '` (one colon followed by one space).
6969

70-
For convenience, a <keyAlias> can be configured to make using `--trailer`
70+
For convenience, a <key-alias> can be configured to make using `--trailer`
7171
shorter to type on the command line. This can be configured using the
72-
'trailer.<keyAlias>.key' configuration variable. The <keyAlias> must be a prefix
72+
'trailer.<key-alias>.key' configuration variable. The <keyAlias> must be a prefix
7373
of the full <key> string, although case sensitivity does not matter. For
7474
example, if you have
7575

Documentation/git-pull.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ OPTIONS
8787
--verbose::
8888
Pass --verbose to git-fetch and git-merge.
8989

90-
--[no-]recurse-submodules[=yes|on-demand|no]::
90+
--[no-]recurse-submodules[=(yes|on-demand|no)]::
9191
This option controls if new commits of populated submodules should
9292
be fetched, and if the working trees of active submodules should be
9393
updated, too (see linkgit:git-fetch[1], linkgit:git-config[1] and
@@ -105,7 +105,7 @@ Options related to merging
105105
include::merge-options.txt[]
106106

107107
-r::
108-
--rebase[=false|true|merges|interactive]::
108+
--rebase[=(false|true|merges|interactive)]::
109109
When true, rebase the current branch on top of the upstream
110110
branch after fetching. If there is a remote-tracking branch
111111
corresponding to the upstream branch and the upstream branch

Documentation/git-rebase.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ SYNOPSIS
1212
[--onto <newbase> | --keep-base] [<upstream> [<branch>]]
1313
'git rebase' [-i | --interactive] [<options>] [--exec <cmd>] [--onto <newbase>]
1414
--root [<branch>]
15-
'git rebase' (--continue | --skip | --abort | --quit | --edit-todo | --show-current-patch)
15+
'git rebase' (--continue|--skip|--abort|--quit|--edit-todo|--show-current-patch)
1616

1717
DESCRIPTION
1818
-----------

Documentation/git-send-email.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ git-send-email - Send a collection of patches as emails
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git send-email' [<options>] <file|directory>...
12+
'git send-email' [<options>] (<file>|<directory>)...
1313
'git send-email' [<options>] <format-patch-options>
1414
'git send-email' --dump-aliases
1515

@@ -278,7 +278,7 @@ must be used for each option.
278278
if a username is not specified (with `--smtp-user` or `sendemail.smtpUser`),
279279
then authentication is not attempted.
280280

281-
--smtp-debug=0|1::
281+
--smtp-debug=(0|1)::
282282
Enable (1) or disable (0) debug output. If enabled, SMTP
283283
commands and replies will be printed. Useful to debug TLS
284284
connection and authentication problems.
@@ -301,7 +301,9 @@ must be used for each option.
301301
Automating
302302
~~~~~~~~~~
303303

304-
--no-[to|cc|bcc]::
304+
--no-to::
305+
--no-cc::
306+
--no-bcc::
305307
Clears any list of "To:", "Cc:", "Bcc:" addresses previously
306308
set via config.
307309

Documentation/git.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -960,7 +960,7 @@ will never be returned from the commit-graph at the cost of performance.
960960
`GIT_PROTOCOL`::
961961
For internal use only. Used in handshaking the wire protocol.
962962
Contains a colon ':' separated list of keys with optional values
963-
'key[=value]'. Presence of unknown keys and values must be
963+
'<key>[=<value>]'. Presence of unknown keys and values must be
964964
ignored.
965965
+
966966
Note that servers may need to be configured to allow this variable to

Documentation/rev-list-options.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -316,12 +316,12 @@ list.
316316
With `--pretty` format other than `oneline` and `reference` (for obvious reasons),
317317
this causes the output to have two extra lines of information
318318
taken from the reflog. The reflog designator in the output may be shown
319-
as `ref@{Nth}` (where `Nth` is the reverse-chronological index in the
320-
reflog) or as `ref@{timestamp}` (with the timestamp for that entry),
319+
as `ref@{<Nth>}` (where _<Nth>_ is the reverse-chronological index in the
320+
reflog) or as `ref@{<timestamp>}` (with the _<timestamp>_ for that entry),
321321
depending on a few rules:
322322
+
323323
--
324-
1. If the starting point is specified as `ref@{Nth}`, show the index
324+
1. If the starting point is specified as `ref@{<Nth>}`, show the index
325325
format.
326326
+
327327
2. If the starting point was specified as `ref@{now}`, show the

builtin/interpret-trailers.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
static const char * const git_interpret_trailers_usage[] = {
1717
N_("git interpret-trailers [--in-place] [--trim-empty]\n"
18-
" [(--trailer (<key>|<keyAlias>)[(=|:)<value>])...]\n"
18+
" [(--trailer (<key>|<key-alias>)[(=|:)<value>])...]\n"
1919
" [--parse] [<file>...]"),
2020
NULL
2121
};

0 commit comments

Comments
 (0)