doc: convert git-mv to new documentation format
- Switch the synopsis to a synopsis block which will automatically format placeholders in italics and keywords in monospace - 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. Unfortunately, there's an inconsistency in the synopsis style, where the ellipsis is used to indicate that the option can be repeated, but it can also be used in Git's three-dot notation to indicate a range of commits. The rendering engine will not be able to distinguish between these two cases. Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>maint
parent
8d34d3379f
commit
1d5378a8c4
|
@ -8,17 +8,18 @@ git-mv - Move or rename a file, a directory, or a symlink
|
||||||
|
|
||||||
SYNOPSIS
|
SYNOPSIS
|
||||||
--------
|
--------
|
||||||
[verse]
|
|
||||||
'git mv' [-v] [-f] [-n] [-k] <source> <destination>
|
[synopsis]
|
||||||
'git mv' [-v] [-f] [-n] [-k] <source> ... <destination-directory>
|
git mv [-v] [-f] [-n] [-k] <source> <destination>
|
||||||
|
git mv [-v] [-f] [-n] [-k] <source>... <destination-directory>
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Move or rename a file, directory, or symlink.
|
Move or rename a file, directory, or symlink.
|
||||||
|
|
||||||
In the first form, it renames <source>, which must exist and be either
|
In the first form, it renames _<source>_, which must exist and be either
|
||||||
a file, symlink or directory, to <destination>.
|
a file, symlink or directory, to _<destination>_.
|
||||||
In the second form, the last argument has to be an existing
|
In the second form, _<destination-directory>_ has to be an existing
|
||||||
directory; the given sources will be moved into this directory.
|
directory; the given sources will be moved into this directory.
|
||||||
|
|
||||||
The index is updated after successful completion, but the change must still be
|
The index is updated after successful completion, but the change must still be
|
||||||
|
@ -26,20 +27,20 @@ committed.
|
||||||
|
|
||||||
OPTIONS
|
OPTIONS
|
||||||
-------
|
-------
|
||||||
-f::
|
`-f`::
|
||||||
--force::
|
`--force`::
|
||||||
Force renaming or moving of a file even if the <destination> exists.
|
Force renaming or moving of a file even if the <destination> exists.
|
||||||
-k::
|
`-k`::
|
||||||
Skip move or rename actions which would lead to an error
|
Skip move or rename actions which would lead to an error
|
||||||
condition. An error happens when a source is neither existing nor
|
condition. An error happens when a source is neither existing nor
|
||||||
controlled by Git, or when it would overwrite an existing
|
controlled by Git, or when it would overwrite an existing
|
||||||
file unless `-f` is given.
|
file unless `-f` is given.
|
||||||
-n::
|
`-n`::
|
||||||
--dry-run::
|
`--dry-run`::
|
||||||
Do nothing; only show what would happen
|
Do nothing; only show what would happen
|
||||||
|
|
||||||
-v::
|
`-v`::
|
||||||
--verbose::
|
`--verbose`::
|
||||||
Report the names of files as they are moved.
|
Report the names of files as they are moved.
|
||||||
|
|
||||||
SUBMODULES
|
SUBMODULES
|
||||||
|
@ -47,8 +48,8 @@ SUBMODULES
|
||||||
Moving a submodule using a gitfile (which means they were cloned
|
Moving a submodule using a gitfile (which means they were cloned
|
||||||
with a Git version 1.7.8 or newer) will update the gitfile and
|
with a Git version 1.7.8 or newer) will update the gitfile and
|
||||||
core.worktree setting to make the submodule work in the new location.
|
core.worktree setting to make the submodule work in the new location.
|
||||||
It also will attempt to update the submodule.<name>.path setting in
|
It also will attempt to update the `submodule.<name>.path` setting in
|
||||||
the linkgit:gitmodules[5] file and stage that file (unless -n is used).
|
the linkgit:gitmodules[5] file and stage that file (unless `-n` is used).
|
||||||
|
|
||||||
BUGS
|
BUGS
|
||||||
----
|
----
|
||||||
|
|
|
@ -29,7 +29,7 @@
|
||||||
|
|
||||||
static const char * const builtin_mv_usage[] = {
|
static const char * const builtin_mv_usage[] = {
|
||||||
N_("git mv [-v] [-f] [-n] [-k] <source> <destination>"),
|
N_("git mv [-v] [-f] [-n] [-k] <source> <destination>"),
|
||||||
N_("git mv [-v] [-f] [-n] [-k] <source> ... <destination-directory>"),
|
N_("git mv [-v] [-f] [-n] [-k] <source>... <destination-directory>"),
|
||||||
NULL
|
NULL
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue