freshlybakedca.ke / git
Git fork
fork atom

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>

authored by

Jean-Noël Avila and committed by
Junio C Hamano 1d5378a8 8d34d337

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