submodule: document module_clone arguments in comments
Signed-off-by: W. Trevor King <wking@tremily.us> Signed-off-by: Junio C Hamano <gitster@pobox.com>
W. Trevor King committed
Jan 15, 2014 at 20:10 UTC
9adfc1cfa7e4b0081e988cc37f31f5e56be8f339
1 file changed
+6
git-submodule.sh
+6
@@ -241,6 +241,12 @@ module_name()
241
#
242
# Clone a submodule
243
#
244
+# $1 = submodule path
245
+# $2 = submodule name
246
+# $3 = URL to clone
247
+# $4 = reference repository to reuse (empty for independent)
248
+# $5 = depth argument for shallow clones (empty for deep)
249
+#
250
# Prior to calling, cmd_update checks that a possibly existing
251
# path is not a git repository.
252
# Likewise, cmd_add checks that path does not exist at all,