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>
Jean-Noël Avila committed
Apr 12, 2025 at 12:20 UTC
1d5378a8c45bfcb34a7be6edde6c6159632ed9be
2 files changed
+17
-16
Documentation/git-mv.adoc
+16
-15
@@ -8,17 +8,18 @@ git-mv - Move or rename a file, a directory, or a symlink
8
9
SYNOPSIS
10
--------
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>
15
16
DESCRIPTION
17
-----------
18
Move or rename a file, directory, or symlink.
19
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
23
directory; the given sources will be moved into this directory.
24
25
The index is updated after successful completion, but the change must still be
@@ -26,20 +27,20 @@ committed.
27
28
OPTIONS
29
-------
29
--f::
30
---force::
30
+`-f`::
31
+`--force`::
32
Force renaming or moving of a file even if the <destination> exists.
32
--k::
33
+`-k`::
34
Skip move or rename actions which would lead to an error
35
condition. An error happens when a source is neither existing nor
36
controlled by Git, or when it would overwrite an existing
37
file unless `-f` is given.
37
--n::
38
---dry-run::
38
+`-n`::
39
+`--dry-run`::
40
Do nothing; only show what would happen
41
41
--v::
42
---verbose::
42
+`-v`::
43
+`--verbose`::
44
Report the names of files as they are moved.
45
46
SUBMODULES
@@ -47,8 +48,8 @@ SUBMODULES
48
Moving a submodule using a gitfile (which means they were cloned
49
with a Git version 1.7.8 or newer) will update the gitfile and
50
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).
53
54
BUGS
55
----
builtin/mv.c
+1
-1
@@ -29,7 +29,7 @@
29
30
static const char * const builtin_mv_usage[] = {
31
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>"),
33
NULL
34
};
35