submodule: document module_clone arguments in comments

wking · gitster · commit 9adfc1cfa7e4 · 2014-02-24T14:35:44.000-08:00
Signed-off-by: W. Trevor King &lt;wking@tremily.us&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
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,

Original file line number	Diff line number	Diff line change
`@@ -241,6 +241,12 @@ module_name()`
`241`	`241`	`#`
`242`	`242`	`# Clone a submodule`
`243`	`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`	`+#`
`244`	`250`	`# Prior to calling, cmd_update checks that a possibly existing`
`245`	`251`	`# path is not a git repository.`
`246`	`252`	`# Likewise, cmd_add checks that path does not exist at all,`