summaryrefslogtreecommitdiff
path: root/git-submodule.sh
diff options
context:
space:
mode:
authorW. Trevor King <wking@tremily.us>2014-01-15 20:10:23 -0800
committerJunio C Hamano <gitster@pobox.com>2014-02-24 14:35:44 -0800
commit9adfc1cfa7e4b0081e988cc37f31f5e56be8f339 (patch)
tree0616d1bcb91b09a9f1ee466e4e79183a2898fedc /git-submodule.sh
parenta2aed08b4152921d5651e42c09c8945a259e3443 (diff)
downloadgit-9adfc1cfa7e4b0081e988cc37f31f5e56be8f339.tar.gz
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>
Diffstat (limited to 'git-submodule.sh')
-rwxr-xr-xgit-submodule.sh6
1 files changed, 6 insertions, 0 deletions
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,