aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJean-Noël Avila <jn.avila@free.fr>2025-04-12 12:20:48 +0000
committerJunio C Hamano <gitster@pobox.com>2025-04-14 14:43:52 -0700
commit1d5378a8c45bfcb34a7be6edde6c6159632ed9be (patch)
treebb1a395a650dc902f548c666ab7f5f025a04c080
parentdoc: move synopsis git-mv commands in the synopsis section (diff)
downloadgit-1d5378a8c45bfcb34a7be6edde6c6159632ed9be.tar.gz
git-1d5378a8c45bfcb34a7be6edde6c6159632ed9be.zip
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>
Diffstat (limited to '')
-rw-r--r--Documentation/git-mv.adoc31
-rw-r--r--builtin/mv.c2
2 files changed, 17 insertions, 16 deletions
diff --git a/Documentation/git-mv.adoc b/Documentation/git-mv.adoc
index 08d660643f..f707e998f7 100644
--- a/Documentation/git-mv.adoc
+++ b/Documentation/git-mv.adoc
@@ -8,17 +8,18 @@ git-mv - Move or rename a file, a directory, or a symlink
SYNOPSIS
--------
-[verse]
-'git mv' [-v] [-f] [-n] [-k] <source> <destination>
-'git mv' [-v] [-f] [-n] [-k] <source> ... <destination-directory>
+
+[synopsis]
+git mv [-v] [-f] [-n] [-k] <source> <destination>
+git mv [-v] [-f] [-n] [-k] <source>... <destination-directory>
DESCRIPTION
-----------
Move or rename a file, directory, or symlink.
-In the first form, it renames <source>, which must exist and be either
-a file, symlink or directory, to <destination>.
-In the second form, the last argument has to be an existing
+In the first form, it renames _<source>_, which must exist and be either
+a file, symlink or directory, to _<destination>_.
+In the second form, _<destination-directory>_ has to be an existing
directory; the given sources will be moved into this directory.
The index is updated after successful completion, but the change must still be
@@ -26,20 +27,20 @@ committed.
OPTIONS
-------
--f::
---force::
+`-f`::
+`--force`::
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
condition. An error happens when a source is neither existing nor
controlled by Git, or when it would overwrite an existing
file unless `-f` is given.
--n::
---dry-run::
+`-n`::
+`--dry-run`::
Do nothing; only show what would happen
--v::
---verbose::
+`-v`::
+`--verbose`::
Report the names of files as they are moved.
SUBMODULES
@@ -47,8 +48,8 @@ SUBMODULES
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
core.worktree setting to make the submodule work in the new location.
-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).
+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).
BUGS
----
diff --git a/builtin/mv.c b/builtin/mv.c
index 9e36b616ab..d673a6c83e 100644
--- a/builtin/mv.c
+++ b/builtin/mv.c
@@ -29,7 +29,7 @@
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-directory>"),
+ N_("git mv [-v] [-f] [-n] [-k] <source>... <destination-directory>"),
NULL
};