1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-05-11 18:16:29 +02:00

Merge branch 'ja/doc-formatting-fix'

Documentation mark-up fix.

* ja/doc-formatting-fix:
  doc: fix some placeholders formating
  doc: format alternatives in synopsis
This commit is contained in:
Junio C Hamano 2024-03-25 16:16:34 -07:00
commit 0cb25d1744
8 changed files with 17 additions and 15 deletions

View File

@ -202,7 +202,7 @@ endif::git-pull[]
destination of an explicit refspec; see `--prune`). destination of an explicit refspec; see `--prune`).
ifndef::git-pull[] ifndef::git-pull[]
--recurse-submodules[=yes|on-demand|no]:: --recurse-submodules[=(yes|on-demand|no)]::
This option controls if and under what conditions new commits of This option controls if and under what conditions new commits of
submodules should be fetched too. When recursing through submodules, submodules should be fetched too. When recursing through submodules,
`git fetch` always attempts to fetch "changed" submodules, that is, a `git fetch` always attempts to fetch "changed" submodules, that is, a

View File

@ -9,7 +9,7 @@ SYNOPSIS
-------- --------
[verse] [verse]
'git interpret-trailers' [--in-place] [--trim-empty] 'git interpret-trailers' [--in-place] [--trim-empty]
[(--trailer (<key>|<keyAlias>)[(=|:)<value>])...] [(--trailer (<key>|<key-alias>)[(=|:)<value>])...]
[--parse] [<file>...] [--parse] [<file>...]
DESCRIPTION DESCRIPTION
@ -67,9 +67,9 @@ key: value
This means that the trimmed <key> and <value> will be separated by This means that the trimmed <key> and <value> will be separated by
`': '` (one colon followed by one space). `': '` (one colon followed by one space).
For convenience, a <keyAlias> can be configured to make using `--trailer` For convenience, a <key-alias> can be configured to make using `--trailer`
shorter to type on the command line. This can be configured using the shorter to type on the command line. This can be configured using the
'trailer.<keyAlias>.key' configuration variable. The <keyAlias> must be a prefix 'trailer.<key-alias>.key' configuration variable. The <keyAlias> must be a prefix
of the full <key> string, although case sensitivity does not matter. For of the full <key> string, although case sensitivity does not matter. For
example, if you have example, if you have

View File

@ -87,7 +87,7 @@ OPTIONS
--verbose:: --verbose::
Pass --verbose to git-fetch and git-merge. Pass --verbose to git-fetch and git-merge.
--[no-]recurse-submodules[=yes|on-demand|no]:: --[no-]recurse-submodules[=(yes|on-demand|no)]::
This option controls if new commits of populated submodules should This option controls if new commits of populated submodules should
be fetched, and if the working trees of active submodules should be be fetched, and if the working trees of active submodules should be
updated, too (see linkgit:git-fetch[1], linkgit:git-config[1] and updated, too (see linkgit:git-fetch[1], linkgit:git-config[1] and
@ -105,7 +105,7 @@ Options related to merging
include::merge-options.txt[] include::merge-options.txt[]
-r:: -r::
--rebase[=false|true|merges|interactive]:: --rebase[=(false|true|merges|interactive)]::
When true, rebase the current branch on top of the upstream When true, rebase the current branch on top of the upstream
branch after fetching. If there is a remote-tracking branch branch after fetching. If there is a remote-tracking branch
corresponding to the upstream branch and the upstream branch corresponding to the upstream branch and the upstream branch

View File

@ -12,7 +12,7 @@ SYNOPSIS
[--onto <newbase> | --keep-base] [<upstream> [<branch>]] [--onto <newbase> | --keep-base] [<upstream> [<branch>]]
'git rebase' [-i | --interactive] [<options>] [--exec <cmd>] [--onto <newbase>] 'git rebase' [-i | --interactive] [<options>] [--exec <cmd>] [--onto <newbase>]
--root [<branch>] --root [<branch>]
'git rebase' (--continue | --skip | --abort | --quit | --edit-todo | --show-current-patch) 'git rebase' (--continue|--skip|--abort|--quit|--edit-todo|--show-current-patch)
DESCRIPTION DESCRIPTION
----------- -----------

View File

@ -9,7 +9,7 @@ git-send-email - Send a collection of patches as emails
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'git send-email' [<options>] <file|directory>... 'git send-email' [<options>] (<file>|<directory>)...
'git send-email' [<options>] <format-patch-options> 'git send-email' [<options>] <format-patch-options>
'git send-email' --dump-aliases 'git send-email' --dump-aliases
@ -278,7 +278,7 @@ must be used for each option.
if a username is not specified (with `--smtp-user` or `sendemail.smtpUser`), if a username is not specified (with `--smtp-user` or `sendemail.smtpUser`),
then authentication is not attempted. then authentication is not attempted.
--smtp-debug=0|1:: --smtp-debug=(0|1)::
Enable (1) or disable (0) debug output. If enabled, SMTP Enable (1) or disable (0) debug output. If enabled, SMTP
commands and replies will be printed. Useful to debug TLS commands and replies will be printed. Useful to debug TLS
connection and authentication problems. connection and authentication problems.
@ -301,7 +301,9 @@ must be used for each option.
Automating Automating
~~~~~~~~~~ ~~~~~~~~~~
--no-[to|cc|bcc]:: --no-to::
--no-cc::
--no-bcc::
Clears any list of "To:", "Cc:", "Bcc:" addresses previously Clears any list of "To:", "Cc:", "Bcc:" addresses previously
set via config. set via config.

View File

@ -960,7 +960,7 @@ will never be returned from the commit-graph at the cost of performance.
`GIT_PROTOCOL`:: `GIT_PROTOCOL`::
For internal use only. Used in handshaking the wire protocol. For internal use only. Used in handshaking the wire protocol.
Contains a colon ':' separated list of keys with optional values Contains a colon ':' separated list of keys with optional values
'key[=value]'. Presence of unknown keys and values must be '<key>[=<value>]'. Presence of unknown keys and values must be
ignored. ignored.
+ +
Note that servers may need to be configured to allow this variable to Note that servers may need to be configured to allow this variable to

View File

@ -316,12 +316,12 @@ list.
With `--pretty` format other than `oneline` and `reference` (for obvious reasons), With `--pretty` format other than `oneline` and `reference` (for obvious reasons),
this causes the output to have two extra lines of information this causes the output to have two extra lines of information
taken from the reflog. The reflog designator in the output may be shown taken from the reflog. The reflog designator in the output may be shown
as `ref@{Nth}` (where `Nth` is the reverse-chronological index in the as `ref@{<Nth>}` (where _<Nth>_ is the reverse-chronological index in the
reflog) or as `ref@{timestamp}` (with the timestamp for that entry), reflog) or as `ref@{<timestamp>}` (with the _<timestamp>_ for that entry),
depending on a few rules: depending on a few rules:
+ +
-- --
1. If the starting point is specified as `ref@{Nth}`, show the index 1. If the starting point is specified as `ref@{<Nth>}`, show the index
format. format.
+ +
2. If the starting point was specified as `ref@{now}`, show the 2. If the starting point was specified as `ref@{now}`, show the

View File

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