doc: convert merge options to new synopsis format
- Use _<placeholder>_ instead of <placeholder> in the description - Use `backticks` for keywords and more complex option descriptions. The new rendering engine will apply synopsis rules to these spans. Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
committed by
Junio C Hamano
parent
13d5331ccc
commit
5f3213232f
@@ -1,23 +1,23 @@
|
||||
--commit::
|
||||
--no-commit::
|
||||
`--commit`::
|
||||
`--no-commit`::
|
||||
Perform the merge and commit the result. This option can
|
||||
be used to override --no-commit.
|
||||
be used to override `--no-commit`.
|
||||
ifdef::git-pull[]
|
||||
Only useful when merging.
|
||||
endif::git-pull[]
|
||||
+
|
||||
With --no-commit perform the merge and stop just before creating
|
||||
With `--no-commit` perform the merge and stop just before creating
|
||||
a merge commit, to give the user a chance to inspect and further
|
||||
tweak the merge result before committing.
|
||||
+
|
||||
Note that fast-forward updates do not create a merge commit and
|
||||
therefore there is no way to stop those merges with --no-commit.
|
||||
therefore there is no way to stop those merges with `--no-commit`.
|
||||
Thus, if you want to ensure your branch is not changed or updated
|
||||
by the merge command, use --no-ff with --no-commit.
|
||||
by the merge command, use `--no-ff` with `--no-commit`.
|
||||
|
||||
--edit::
|
||||
-e::
|
||||
--no-edit::
|
||||
`--edit`::
|
||||
`-e`::
|
||||
`--no-edit`::
|
||||
Invoke an editor before committing successful mechanical merge to
|
||||
further edit the auto-generated merge message, so that the user
|
||||
can explain and justify the merge. The `--no-edit` option can be
|
||||
@@ -35,17 +35,17 @@ they run `git merge`. To make it easier to adjust such scripts to the
|
||||
updated behaviour, the environment variable `GIT_MERGE_AUTOEDIT` can be
|
||||
set to `no` at the beginning of them.
|
||||
|
||||
--cleanup=<mode>::
|
||||
`--cleanup=<mode>`::
|
||||
This option determines how the merge message will be cleaned up before
|
||||
committing. See linkgit:git-commit[1] for more details. In addition, if
|
||||
the '<mode>' is given a value of `scissors`, scissors will be appended
|
||||
the _<mode>_ is given a value of `scissors`, scissors will be appended
|
||||
to `MERGE_MSG` before being passed on to the commit machinery in the
|
||||
case of a merge conflict.
|
||||
|
||||
ifdef::git-merge[]
|
||||
--ff::
|
||||
--no-ff::
|
||||
--ff-only::
|
||||
`--ff`::
|
||||
`--no-ff`::
|
||||
`--ff-only`::
|
||||
Specifies how a merge is handled when the merged-in history is
|
||||
already a descendant of the current history. `--ff` is the
|
||||
default unless merging an annotated (and possibly signed) tag
|
||||
@@ -53,13 +53,13 @@ ifdef::git-merge[]
|
||||
hierarchy, in which case `--no-ff` is assumed.
|
||||
endif::git-merge[]
|
||||
ifdef::git-pull[]
|
||||
--ff-only::
|
||||
`--ff-only`::
|
||||
Only update to the new history if there is no divergent local
|
||||
history. This is the default when no method for reconciling
|
||||
divergent histories is provided (via the --rebase=* flags).
|
||||
|
||||
--ff::
|
||||
--no-ff::
|
||||
`--ff`::
|
||||
`--no-ff`::
|
||||
When merging rather than rebasing, specifies how a merge is
|
||||
handled when the merged-in history is already a descendant of
|
||||
the current history. If merging is requested, `--ff` is the
|
||||
@@ -81,40 +81,40 @@ With `--ff-only`, resolve the merge as a fast-forward when possible.
|
||||
When not possible, refuse to merge and exit with a non-zero status.
|
||||
endif::git-merge[]
|
||||
|
||||
-S[<keyid>]::
|
||||
--gpg-sign[=<keyid>]::
|
||||
--no-gpg-sign::
|
||||
GPG-sign the resulting merge commit. The `keyid` argument is
|
||||
`-S[<key-id>]`::
|
||||
`--gpg-sign[=<key-id>]`::
|
||||
`--no-gpg-sign`::
|
||||
GPG-sign the resulting merge commit. The _<key-id>_ argument is
|
||||
optional and defaults to the committer identity; if specified,
|
||||
it must be stuck to the option without a space. `--no-gpg-sign`
|
||||
is useful to countermand both `commit.gpgSign` configuration variable,
|
||||
and earlier `--gpg-sign`.
|
||||
|
||||
--log[=<n>]::
|
||||
--no-log::
|
||||
`--log[=<n>]`::
|
||||
`--no-log`::
|
||||
In addition to branch names, populate the log message with
|
||||
one-line descriptions from at most <n> actual commits that are being
|
||||
one-line descriptions from at most _<n>_ actual commits that are being
|
||||
merged. See also linkgit:git-fmt-merge-msg[1].
|
||||
ifdef::git-pull[]
|
||||
Only useful when merging.
|
||||
endif::git-pull[]
|
||||
+
|
||||
With --no-log do not list one-line descriptions from the
|
||||
With `--no-log` do not list one-line descriptions from the
|
||||
actual commits being merged.
|
||||
|
||||
include::signoff-option.adoc[]
|
||||
|
||||
--stat::
|
||||
-n::
|
||||
--no-stat::
|
||||
`--stat`::
|
||||
`-n`::
|
||||
`--no-stat`::
|
||||
Show a diffstat at the end of the merge. The diffstat is also
|
||||
controlled by the configuration option merge.stat.
|
||||
+
|
||||
With -n or --no-stat do not show a diffstat at the end of the
|
||||
With `-n` or `--no-stat` do not show a diffstat at the end of the
|
||||
merge.
|
||||
|
||||
--squash::
|
||||
--no-squash::
|
||||
`--squash`::
|
||||
`--no-squash`::
|
||||
Produce the working tree and index state as if a real merge
|
||||
happened (except for the merge information), but do not actually
|
||||
make a commit, move the `HEAD`, or record `$GIT_DIR/MERGE_HEAD`
|
||||
@@ -123,16 +123,16 @@ merge.
|
||||
the current branch whose effect is the same as merging another
|
||||
branch (or more in case of an octopus).
|
||||
+
|
||||
With --no-squash perform the merge and commit the result. This
|
||||
option can be used to override --squash.
|
||||
With `--no-squash` perform the merge and commit the result. This
|
||||
option can be used to override `--squash`.
|
||||
+
|
||||
With --squash, --commit is not allowed, and will fail.
|
||||
With `--squash`, `--commit` is not allowed, and will fail.
|
||||
ifdef::git-pull[]
|
||||
+
|
||||
Only useful when merging.
|
||||
endif::git-pull[]
|
||||
|
||||
--[no-]verify::
|
||||
`--[no-]verify`::
|
||||
By default, the pre-merge and commit-msg hooks are run.
|
||||
When `--no-verify` is given, these are bypassed.
|
||||
See also linkgit:githooks[5].
|
||||
@@ -140,21 +140,21 @@ ifdef::git-pull[]
|
||||
Only useful when merging.
|
||||
endif::git-pull[]
|
||||
|
||||
-s <strategy>::
|
||||
--strategy=<strategy>::
|
||||
`-s <strategy>`::
|
||||
`--strategy=<strategy>`::
|
||||
Use the given merge strategy; can be supplied more than
|
||||
once to specify them in the order they should be tried.
|
||||
If there is no `-s` option, a built-in list of strategies
|
||||
is used instead (`ort` when merging a single head,
|
||||
`octopus` otherwise).
|
||||
|
||||
-X <option>::
|
||||
--strategy-option=<option>::
|
||||
`-X <option>`::
|
||||
`--strategy-option=<option>`::
|
||||
Pass merge strategy specific option through to the merge
|
||||
strategy.
|
||||
|
||||
--verify-signatures::
|
||||
--no-verify-signatures::
|
||||
`--verify-signatures`::
|
||||
`--no-verify-signatures`::
|
||||
Verify that the tip commit of the side branch being merged is
|
||||
signed with a valid key, i.e. a key that has a valid uid: in the
|
||||
default trust model, this means the signing key has been signed by
|
||||
@@ -165,22 +165,22 @@ ifdef::git-pull[]
|
||||
Only useful when merging.
|
||||
endif::git-pull[]
|
||||
|
||||
--summary::
|
||||
--no-summary::
|
||||
Synonyms to --stat and --no-stat; these are deprecated and will be
|
||||
`--summary`::
|
||||
`--no-summary`::
|
||||
Synonyms to `--stat` and `--no-stat`; these are deprecated and will be
|
||||
removed in the future.
|
||||
|
||||
ifndef::git-pull[]
|
||||
-q::
|
||||
--quiet::
|
||||
Operate quietly. Implies --no-progress.
|
||||
`-q`::
|
||||
`--quiet`::
|
||||
Operate quietly. Implies `--no-progress`.
|
||||
|
||||
-v::
|
||||
--verbose::
|
||||
`-v`::
|
||||
`--verbose`::
|
||||
Be verbose.
|
||||
|
||||
--progress::
|
||||
--no-progress::
|
||||
`--progress`::
|
||||
`--no-progress`::
|
||||
Turn progress on/off explicitly. If neither is specified,
|
||||
progress is shown if standard error is connected to a terminal.
|
||||
Note that not all merge strategies may support progress
|
||||
@@ -188,8 +188,8 @@ ifndef::git-pull[]
|
||||
|
||||
endif::git-pull[]
|
||||
|
||||
--autostash::
|
||||
--no-autostash::
|
||||
`--autostash`::
|
||||
`--no-autostash`::
|
||||
Automatically create a temporary stash entry before the operation
|
||||
begins, record it in the ref `MERGE_AUTOSTASH`
|
||||
and apply it after the operation ends. This means
|
||||
@@ -197,7 +197,7 @@ endif::git-pull[]
|
||||
with care: the final stash application after a successful
|
||||
merge might result in non-trivial conflicts.
|
||||
|
||||
--allow-unrelated-histories::
|
||||
`--allow-unrelated-histories`::
|
||||
By default, `git merge` command refuses to merge histories
|
||||
that do not share a common ancestor. This option can be
|
||||
used to override this safety when merging histories of two
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
--rerere-autoupdate::
|
||||
--no-rerere-autoupdate::
|
||||
`--rerere-autoupdate`::
|
||||
`--no-rerere-autoupdate`::
|
||||
After the rerere mechanism reuses a recorded resolution on
|
||||
the current conflict to update the files in the working
|
||||
tree, allow it to also update the index with the result of
|
||||
|
||||
Reference in New Issue
Block a user