git-mv(1) [xfree86 man page]

GIT-MV(1)							    Git Manual								 GIT-MV(1)

NAME
       git-mv - Move or rename a file, a directory, or a symlink

SYNOPSIS
       git mv <options>... <args>...

DESCRIPTION
       Move or rename a file, directory or symlink.

	   git mv [-v] [-f] [-n] [-k] <source> <destination>
	   git mv [-v] [-f] [-n] [-k] <source> ... <destination directory>

       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.

       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 target 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 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 git(1) suite

Git 2.17.1							    10/05/2018								 GIT-MV(1)

GITMODULES(5)							    Git Manual							     GITMODULES(5)

NAME

       gitmodules - defining submodule properties

SYNOPSIS

       $GIT_WORK_DIR/.gitmodules

DESCRIPTION

       The .gitmodules file, located in the top-level directory of a git working tree, is a text file with a syntax matching the requirements of
       git-config(1).

       The file contains one subsection per submodule, and the subsection value is the name of the submodule. Each submodule section also contains
       the following required keys:

       submodule.<name>.path
	   Defines the path, relative to the top-level directory of the git working tree, where the submodule is expected to be checked out. The
	   path name must not end with a /. All submodule paths must be unique within the .gitmodules file.

       submodule.<name>.url
	   Defines a URL from which the submodule repository can be cloned. This may be either an absolute URL ready to be passed to git-clone(1)
	   or (if it begins with ./ or ../) a location relative to the superproject's origin repository.

       submodule.<name>.update
	   Defines what to do when the submodule is updated by the superproject. If checkout (the default), the new commit specified in the
	   superproject will be checked out in the submodule on a detached HEAD. If rebase, the current branch of the submodule will be rebased
	   onto the commit specified in the superproject. If merge, the commit specified in the superproject will be merged into the current
	   branch in the submodule. If none, the submodule with name $name will not be updated by default.

	       This config option is overridden if 'git submodule update' is given
	       the '--merge', '--rebase' or '--checkout' options.

       submodule.<name>.fetchRecurseSubmodules
	   This option can be used to control recursive fetching of this submodule. If this option is also present in the submodules entry in
	   .git/config of the superproject, the setting there will override the one found in .gitmodules. Both settings can be overridden on the
	   command line by using the "--[no-]recurse-submodules" option to "git fetch" and "git pull".

       submodule.<name>.ignore
	   Defines under what circumstances "git status" and the diff family show a submodule as modified. When set to "all", it will never be
	   considered modified, "dirty" will ignore all changes to the submodules work tree and takes only differences between the HEAD of the
	   submodule and the commit recorded in the superproject into account. "untracked" will additionally let submodules with modified tracked
	   files in their work tree show up. Using "none" (the default when this option is not set) also shows submodules that have untracked
	   files in their work tree as changed. If this option is also present in the submodules entry in .git/config of the superproject, the
	   setting there will override the one found in .gitmodules. Both settings can be overridden on the command line by using the
	   "--ignore-submodule" option.

EXAMPLES

       Consider the following .gitmodules file:

	   [submodule "libfoo"]
		   path = include/foo
		   url = git://foo.com/git/lib.git

	   [submodule "libbar"]
		   path = include/bar
		   url = git://bar.com/git/lib.git

       This defines two submodules, libfoo and libbar. These are expected to be checked out in the paths include/foo and include/bar, and for both
       submodules a URL is specified which can be used for cloning the submodules.

SEE ALSO

       git-submodule(1) git-config(1)

GIT

       Part of the git(1) suite

Git 1.7.10.4							    11/24/2012							     GITMODULES(5)