submodule doc: reorder introductory paragraphs
commitec48a76306091abfa7831a97f36949ab82432ddc
authorStefan Beller <sbeller@google.com>
Wed, 27 May 2015 19:48:01 +0000 (27 12:48 -0700)
committerJunio C Hamano <gitster@pobox.com>
Thu, 28 May 2015 22:18:11 +0000 (28 15:18 -0700)
tree285be43e0dc98f6e1dd9d896e458e7c214c82bc4
parent3d4a3ffe64162b45ae7c991fc60623ecb4678cfd
submodule doc: reorder introductory paragraphs

It's better to start the man page with a description of what
submodules actually are, instead of saying what they are not.

Reorder the paragraphs such that

 - the first short paragraph introduces the submodule concept,
 - the second paragraph highlights the usage of the submodule command,
 - the third paragraph giving background information, and finally
 - the fourth paragraph discusing alternatives such as subtrees and
   remotes, which we don't want to be confused with.

This ordering deepens the knowledge on submodules with each paragraph.
First the basic questions like "How/what" will be answered, while the
underlying concepts will be taught at a later time.

Making sure it is not confused with subtrees and remotes is not really
enhancing knowledge of submodules itself, but rather painting the big
picture of git concepts, so you could also argue to have it as the second
paragraph. Personally I think this may confuse readers, specially
newcomers though.

Additionally to reordering the paragraphs, they have been slightly
reworded.

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