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>
This commit is contained in:
W. Trevor King 2014-01-15 20:10:23 -08:00 committed by Junio C Hamano
parent a2aed08b41
commit 9adfc1cfa7

View file

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