Skip to content

Commit 1868dfc

Browse files
committed
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>
1 parent 2a12973 commit 1868dfc

File tree

2 files changed

+17
-16
lines changed

2 files changed

+17
-16
lines changed

Diff for: Documentation/git-mv.adoc

+16-15
Original file line numberDiff line numberDiff line change
@@ -8,47 +8,48 @@ git-mv - Move or rename a file, a directory, or a symlink
88

99
SYNOPSIS
1010
--------
11-
[verse]
12-
'git mv' [-v] [-f] [-n] [-k] <source> <destination>
13-
'git mv' [-v] [-f] [-n] [-k] <source> ... <destination-directory>
11+
12+
[synopsis]
13+
git mv [-v] [-f] [-n] [-k] <source> <destination>
14+
git mv [-v] [-f] [-n] [-k] <source>... <destination-directory>
1415

1516
DESCRIPTION
1617
-----------
1718
Move or rename a file, directory, or symlink.
1819

19-
In the first form, it renames <source>, which must exist and be either
20-
a file, symlink or directory, to <destination>.
21-
In the second form, the last argument has to be an existing
20+
In the first form, it renames _<source>_, which must exist and be either
21+
a file, symlink or directory, to _<destination>_.
22+
In the second form, _<destination-directory>_ has to be an existing
2223
directory; the given sources will be moved into this directory.
2324

2425
The index is updated after successful completion, but the change must still be
2526
committed.
2627

2728
OPTIONS
2829
-------
29-
-f::
30-
--force::
30+
`-f`::
31+
`--force`::
3132
Force renaming or moving of a file even if the <destination> exists.
32-
-k::
33+
`-k`::
3334
Skip move or rename actions which would lead to an error
3435
condition. An error happens when a source is neither existing nor
3536
controlled by Git, or when it would overwrite an existing
3637
file unless `-f` is given.
37-
-n::
38-
--dry-run::
38+
`-n`::
39+
`--dry-run`::
3940
Do nothing; only show what would happen
4041

41-
-v::
42-
--verbose::
42+
`-v`::
43+
`--verbose`::
4344
Report the names of files as they are moved.
4445

4546
SUBMODULES
4647
----------
4748
Moving a submodule using a gitfile (which means they were cloned
4849
with a Git version 1.7.8 or newer) will update the gitfile and
4950
core.worktree setting to make the submodule work in the new location.
50-
It also will attempt to update the submodule.<name>.path setting in
51-
the linkgit:gitmodules[5] file and stage that file (unless -n is used).
51+
It also will attempt to update the `submodule.<name>.path` setting in
52+
the linkgit:gitmodules[5] file and stage that file (unless `-n` is used).
5253

5354
BUGS
5455
----

Diff for: builtin/mv.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929

3030
static const char * const builtin_mv_usage[] = {
3131
N_("git mv [-v] [-f] [-n] [-k] <source> <destination>"),
32-
N_("git mv [-v] [-f] [-n] [-k] <source> ... <destination-directory>"),
32+
N_("git mv [-v] [-f] [-n] [-k] <source>... <destination-directory>"),
3333
NULL
3434
};
3535

0 commit comments

Comments
 (0)