diff options
Diffstat (limited to 'Documentation/git-mv.adoc')
| -rw-r--r-- | Documentation/git-mv.adoc | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/Documentation/git-mv.adoc b/Documentation/git-mv.adoc new file mode 100644 index 0000000000..f707e998f7 --- /dev/null +++ b/Documentation/git-mv.adoc @@ -0,0 +1,68 @@ +git-mv(1) +========= + +NAME +---- +git-mv - Move or rename a file, a directory, or a symlink + + +SYNOPSIS +-------- + +[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, _<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 +committed. + +OPTIONS +------- +`-f`:: +`--force`:: + Force renaming or moving of a file even if the <destination> exists. +`-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`:: + Do nothing; only show what would happen + +`-v`:: +`--verbose`:: + Report the names of files as they are moved. + +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). + +BUGS +---- +Each time a superproject update moves a populated submodule (e.g. when +switching between commits before and after the move) a stale submodule +checkout will remain in the old location and an empty directory will +appear in the new location. To populate the submodule again in the new +location the user will have to run "git submodule update" +afterwards. Removing the old directory is only safe when it uses a +gitfile, as otherwise the history of the submodule will be deleted +too. Both steps will be obsolete when recursive submodule update has +been implemented. + +GIT +--- +Part of the linkgit:git[1] suite |