Skip to content

Commit a7f97d2

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 <[email protected]>
1 parent 41a0196 commit a7f97d2

File tree

1 file changed

+15
-17
lines changed

1 file changed

+15
-17
lines changed

Documentation/git-mv.adoc

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

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

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

18-
git mv [-v] [-f] [-n] [-k] <source> <destination>
19-
git mv [-v] [-f] [-n] [-k] <source> ... <destination-directory>
20-
21-
In the first form, it renames <source>, which must exist and be either
22-
a file, symlink or directory, to <destination>.
23-
In the second form, the last argument has to be an existing
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, _<destination-directory>_ has to be an existing
2422
directory; the given sources will be moved into this directory.
2523

2624
The index is updated after successful completion, but the change must still be
2725
committed.
2826

2927
OPTIONS
3028
-------
31-
-f::
32-
--force::
29+
`-f`::
30+
`--force`::
3331
Force renaming or moving of a file even if the <destination> exists.
34-
-k::
32+
`-k`::
3533
Skip move or rename actions which would lead to an error
3634
condition. An error happens when a source is neither existing nor
3735
controlled by Git, or when it would overwrite an existing
3836
file unless `-f` is given.
39-
-n::
40-
--dry-run::
37+
`-n`::
38+
`--dry-run`::
4139
Do nothing; only show what would happen
4240

43-
-v::
44-
--verbose::
41+
`-v`::
42+
`--verbose`::
4543
Report the names of files as they are moved.
4644

4745
SUBMODULES
4846
----------
4947
Moving a submodule using a gitfile (which means they were cloned
5048
with a Git version 1.7.8 or newer) will update the gitfile and
5149
core.worktree setting to make the submodule work in the new location.
52-
It also will attempt to update the submodule.<name>.path setting in
53-
the linkgit:gitmodules[5] file and stage that file (unless -n is used).
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).
5452

5553
BUGS
5654
----

0 commit comments

Comments
 (0)