Thread (25 messages) 25 messages, 6 authors, 2016-06-15
DORMANTno replies

[PATCH v3 3/3] git-submodule: Motivate --record with an example use case

From: W. Trevor King <hidden>
Date: 2016-06-15 22:55:13
Subsystem: documentation, the rest · Maintainers: Jonathan Corbet, Linus Torvalds

From: "W. Trevor King" <redacted>

Signed-off-by: W. Trevor King <redacted>
---
 Documentation/git-submodule.txt | 8 ++++++++
 1 file changed, 8 insertions(+)
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index 9a99826..d4e993f 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -220,6 +220,14 @@ OPTIONS
 	is not set either, `HEAD` will be recorded.  Because the branch name
 	is optional, you must use the equal-sign form (`-r=<branch>`), not
 	`-r <branch>`.
++
+The recorded setting is not actually used by git; however, some
+external tools and workflows may make use of it.  For example, if the
+upstream branches still exist and you have a recorded branch setting
+for each of your submodules, you can update all of the submodules to
+the current branch tips with:
++
+	git submodule foreach 'git checkout $submodule_branch && git pull'
 
 -f::
 --force::
-- 
1.8.0.3.gc2eb43a
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help