[RFC/PATCH 3/4] submodules: update docs to reflect remotes.
---
Documentation/git-submodule.txt | 23 +++++++++++++++++++++++
1 file changed, 23 insertions(+)
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index 2c25916..a49a2ad 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -21,6 +21,9 @@ SYNOPSIS
[commit] [--] [<path>...]
'git submodule' [--quiet] foreach [--recursive] <command>
'git submodule' [--quiet] sync [--recursive] [--] [<path>...]
+'git submodule' [--quiet] remote add <path> <name> <url>
+'git submodule' [--quiet] remote rm <path> <name>
+'git submodule' [--quiet] remote set-url [--push] <path> <name> <url>"
DESCRIPTION
@@ -233,6 +236,22 @@ As an example, +git submodule foreach \'echo $path {backtick}git
rev-parse HEAD{backtick}'+ will show the path and currently checked out
commit for each submodule.
+remote::
+ Modify a submodule's remote configuration. The command has subcommands that
+ mirror the commands of `git remote`. The change will be reflected inside
+ of the .gitmodules file the submodule is specified in. Changes will be
+ synchronized with the submodule by running `git submodule sync`.
++
+ `git submodule remote add <sm_path> <remote> <url>`;;
+ add a new remote with the URL specified to the submodule
+ `git submodule remote rm <sm_path> <remote>`;;
+ remove a remote with the given name for the specified submodule
+ `git submodule remote show [-v|--verbose] <sm_path>`;;
+ show configured remotes for the submodule. If `--verbose` is specified,
+ also print URLs.
+ `git submodule remote set-url [--push] <sm_path> <remote> <url>`;;
+ set the (push) URL for the given remote name and submodule.
+
sync::
Synchronizes submodules' remote URL configuration setting
to the value specified in .gitmodules. It will only affect those
@@ -240,6 +259,10 @@ sync::
case when they are initialized or freshly added). This is useful when
submodule URLs change upstream and you need to update your local
repositories accordingly.
+
+ Also synchronizes all remotes that have been configured in .gitmodules.
+ Missing remotes will be added to the submodule while existing ones will be
+ updated according to the configured fetch or push URLs.
+
"git submodule sync" synchronizes all submodules while
"git submodule sync \-- A" synchronizes submodule "A" only.
--
2.3.5
Patrick Steinhardt <ps@pks.im>