| Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 1 | git-mv(1) |
| 2 | ========= |
| 3 | |
| 4 | NAME |
| 5 | ---- |
| Junio C Hamano | 7c73c66 | 2007-01-19 00:37:50 | [diff] [blame] | 6 | git-mv - Move or rename a file, a directory, or a symlink |
| Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 7 | |
| 8 | |
| 9 | SYNOPSIS |
| 10 | -------- |
| Junio C Hamano | 15567bc | 2011-07-23 00:51:59 | [diff] [blame] | 11 | [verse] |
| Junio C Hamano | cf9c773 | 2022-10-28 18:56:06 | [diff] [blame] | 12 | 'git mv' [<options>] <source>... <destination> |
| Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 13 | |
| 14 | DESCRIPTION |
| 15 | ----------- |
| Junio C Hamano | 33be821 | 2023-10-23 21:45:54 | [diff] [blame] | 16 | Move or rename a file, directory, or symlink. |
| Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 17 | |
| Junio C Hamano | 0df9271 | 2011-12-21 22:30:44 | [diff] [blame] | 18 | git mv [-v] [-f] [-n] [-k] <source> <destination> |
| Junio C Hamano | 6546a50 | 2024-02-08 23:48:36 | [diff] [blame] | 19 | git mv [-v] [-f] [-n] [-k] <source> ... <destination-directory> |
| Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 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 |
| 24 | directory; the given sources will be moved into this directory. |
| 25 | |
| 26 | The index is updated after successful completion, but the change must still be |
| 27 | committed. |
| 28 | |
| 29 | OPTIONS |
| 30 | ------- |
| 31 | -f:: |
| Junio C Hamano | 68cfa3a | 2009-08-30 00:22:55 | [diff] [blame] | 32 | --force:: |
| Junio C Hamano | cf9c773 | 2022-10-28 18:56:06 | [diff] [blame] | 33 | Force renaming or moving of a file even if the <destination> exists. |
| Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 34 | -k:: |
| Junio C Hamano | 92d8037 | 2016-07-13 22:00:05 | [diff] [blame] | 35 | Skip move or rename actions which would lead to an error |
| Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 36 | condition. An error happens when a source is neither existing nor |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 37 | controlled by Git, or when it would overwrite an existing |
| Junio C Hamano | 92d8037 | 2016-07-13 22:00:05 | [diff] [blame] | 38 | file unless `-f` is given. |
| Junio C Hamano | eb41599 | 2008-06-08 22:49:47 | [diff] [blame] | 39 | -n:: |
| 40 | --dry-run:: |
| Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 41 | Do nothing; only show what would happen |
| 42 | |
| Junio C Hamano | 0df9271 | 2011-12-21 22:30:44 | [diff] [blame] | 43 | -v:: |
| 44 | --verbose:: |
| 45 | Report the names of files as they are moved. |
| 46 | |
| Junio C Hamano | 8eac268 | 2013-09-09 22:35:20 | [diff] [blame] | 47 | SUBMODULES |
| 48 | ---------- |
| 49 | Moving a submodule using a gitfile (which means they were cloned |
| 50 | with a Git version 1.7.8 or newer) will update the gitfile and |
| 51 | 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). |
| 54 | |
| Junio C Hamano | bc8d478 | 2014-01-13 23:35:50 | [diff] [blame] | 55 | BUGS |
| 56 | ---- |
| 57 | Each time a superproject update moves a populated submodule (e.g. when |
| 58 | switching between commits before and after the move) a stale submodule |
| 59 | checkout will remain in the old location and an empty directory will |
| 60 | appear in the new location. To populate the submodule again in the new |
| 61 | location the user will have to run "git submodule update" |
| 62 | afterwards. Removing the old directory is only safe when it uses a |
| 63 | gitfile, as otherwise the history of the submodule will be deleted |
| 64 | too. Both steps will be obsolete when recursive submodule update has |
| 65 | been implemented. |
| 66 | |
| Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 67 | GIT |
| 68 | --- |
| Junio C Hamano | f7c042d | 2008-06-06 22:50:53 | [diff] [blame] | 69 | Part of the linkgit:git[1] suite |
