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>
git-mirror · Feb 24, 2014 · 9adfc1c · 9adfc1c
1 parent a2aed08
commit 9adfc1c
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/git-submodule.sh b/git-submodule.sh
@@ -241,6 +241,12 @@ module_name()
 #
 # Clone a submodule
 #
+# $1 = submodule path
+# $2 = submodule name
+# $3 = URL to clone
+# $4 = reference repository to reuse (empty for independent)
+# $5 = depth argument for shallow clones (empty for deep)
+#
 # Prior to calling, cmd_update checks that a possibly existing
 # path is not a git repository.
 # Likewise, cmd_add checks that path does not exist at all,