From: W. Trevor King <wking@tremily.us>
Date: Thu, 16 Jan 2014 04:10:23 +0000 (-0800)
Subject: submodule: document module_clone arguments in comments
X-Git-Tag: v2.0.0-rc0~40^2~2
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=9adfc1cfa7e4b0081e988cc37f31f5e56be8f339;p=thirdparty%2Fgit.git

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>
---

diff --git a/git-submodule.sh b/git-submodule.sh
index 5e8776ce82..68dcbe1bc4 100755
--- 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,