man1/git-mv.1

   1 '\" t
   2 .\"     Title: git-mv
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
   5 .\"      Date: 2024-08-21
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.46.0.288.g3a7362eb9f
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-MV" "1" "2024-08-21" "Git 2\&.46\&.0\&.288\&.g3a7362" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-mv \- Move or rename a file, a directory, or a symlink
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit mv\fR [<options>] <source>\&...\: <destination>
  36 .fi
  37 .SH "DESCRIPTION"
  38 .sp
  39 Move or rename a file, directory, or symlink\&.
  40 .sp
  41 .if n \{\
  42 .RS 4
  43 .\}
  44 .nf
  45 git mv [\-v] [\-f] [\-n] [\-k] <source> <destination>
  46 git mv [\-v] [\-f] [\-n] [\-k] <source> \&.\&.\&. <destination\-directory>
  47 .fi
  48 .if n \{\
  49 .RE
  50 .\}
  51 .sp
  52 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 directory; the given sources will be moved into this directory\&.
  53 .sp
  54 The index is updated after successful completion, but the change must still be committed\&.
  55 .SH "OPTIONS"
  56 .PP
  57 \-f, \-\-force
  58 .RS 4
  59 Force renaming or moving of a file even if the <destination> exists\&.
  60 .RE
  61 .PP
  62 \-k
  63 .RS 4
  64 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
  65 \fB\-f\fR
  66 is given\&.
  67 .RE
  68 .PP
  69 \-n, \-\-dry\-run
  70 .RS 4
  71 Do nothing; only show what would happen
  72 .RE
  73 .PP
  74 \-v, \-\-verbose
  75 .RS 4
  76 Report the names of files as they are moved\&.
  77 .RE
  78 .SH "SUBMODULES"
  79 .sp
  80 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 \fBgitmodules\fR(5) file and stage that file (unless \-n is used)\&.
  81 .SH "BUGS"
  82 .sp
  83 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\&.
  84 .SH "GIT"
  85 .sp
  86 Part of the \fBgit\fR(1) suite