OSDN Git Service

submodule: document module_clone arguments in comments
authorW. Trevor King <wking@tremily.us>
Thu, 16 Jan 2014 04:10:23 +0000 (20:10 -0800)
committerJunio C Hamano <gitster@pobox.com>
Mon, 24 Feb 2014 22:35:44 +0000 (14:35 -0800)
Signed-off-by: W. Trevor King <wking@tremily.us>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
git-submodule.sh

index 5e8776c..68dcbe1 100755 (executable)
@@ -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,