document submodule sync --recursive
commite7220c40b175561a276285e95f3fe8c7a86204f2
authorStefan Beller <sbeller@google.com>
Thu, 3 Dec 2015 20:41:02 +0000 (3 12:41 -0800)
committerJunio C Hamano <gitster@pobox.com>
Fri, 4 Dec 2015 21:08:05 +0000 (4 13:08 -0800)
tree4268a16c269792610b22f3358c15533b5648110b
parent24358560c3c0ab51c9ef8178d99f46711716f6c0
document submodule sync --recursive

The git-submodule(1) is inconsistent. In the synopsis, it says:

       git submodule [--quiet] sync [--recursive] [--] [<path>...]

The description of the sync does not mention --recursive, and the
description of --recursive says that it is only available for foreach,
update and status.

The option was introduced (82f49f294c, Teach --recursive to submodule
sync, 2012-10-26) a while ago, so let's document it, too.

Reported-by: Per Cederqvist <cederp@opera.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-submodule.txt