Documentation/git-submodule: cleanup "add" section
authorKaartic Sivaraam <kaarticsivaraam91196@gmail.com>
Thu, 22 Jun 2017 02:51:42 +0000 (02:51 +0000)
committerJunio C Hamano <gitster@pobox.com>
Thu, 22 Jun 2017 19:38:52 +0000 (12:38 -0700)
commitbeebc6df4c0db886a5bf8c3eb5bf92726e944851
treeaed313a37cb1e165c0413b17ac41cb0e7fdb4adb
parent05ec6e13aaf33b6a647e1321203a770e697eea9a
Documentation/git-submodule: cleanup "add" section

The "add" section for 'git-submodule' is redundant in its
description and the short synopsis line. Fix it.

Remove the redundant mentioning of the 'repository' argument
being mandatory.

The text is hard to read because of back-references, so remove
those.

Replace the word "humanish" by "canonical" as that conveys better
what we do to guess the path.

While at it, quote all occurrences of '.gitmodules' as that is an
important file in the submodule context, also link to it on its
first mention.

Helped-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Kaartic Sivaraam <kaarticsivaraam91196@gmail.com>
Reviewed-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-submodule.txt