git/Documentation/git-submodule.txt, branch v2.4.9

submodule doc: reorder introductory paragraphs

2015-05-28T22:18:11Z

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 Signed-off-by: Junio C Hamano

submodule: improve documentation of update subcommand

2015-03-02T22:59:55Z

The documentation of 'git submodule update' has several problems: 1) It mentions that value 'none' of submodule.$name.update can be overridden by --checkout, but other combinations of configuration values and command line options are not mentioned. 2) The documentation of submodule.$name.update is scattered across three places, which is confusing. 3) The documentation of submodule.$name.update in gitmodules.txt is incorrect, because the code always uses the value from .git/config and never from .gitmodules. 4) Documentation of --force was incomplete, because it is only effective in case of checkout method of update. Fix all these problems by documenting submodule.*.update in git-submodule.txt and make everybody else refer to it. Helped-by: Junio C Hamano Helped-by: Jens Lehmann Signed-off-by: Michal Sojka Signed-off-by: Junio C Hamano

Merge branch 'mc/doc-submodule-sync-recurse' into maint

2014-07-10T18:08:31Z

* mc/doc-submodule-sync-recurse: submodule: document "sync --recursive"

submodule: document "sync --recursive"

2014-06-13T22:00:17Z

The "git submodule sync" command supports the --recursive flag, but the documentation does not mention this. That flag is useful, for example when a remote is changed in a submodule of a submodule. Signed-off-by: Matthew Chen Signed-off-by: Junio C Hamano

Revert "submodule: explicit local branch creation in module_clone"

2014-04-02T21:15:36Z

This reverts commit 23d25e48f5ead73c9ce233986f90791abec9f1e8, as it is broken for users who haven't opted into the new feature of checking out submodule.*.branch with update mode set to checkout.

Revert "Merge branch 'wt/doc-submodule-name-path-confusion-2'"

2014-04-01T18:52:37Z

This reverts commit 00d4ff1a69883e24b095f45251d99143b5bc0320, reversing changes made to d3badc6eb0961382788c2670129d5ee133d079fd.

Merge branch 'wt/doc-submodule-name-path-confusion-2'

2014-03-31T23:31:16Z

* wt/doc-submodule-name-path-confusion-2: doc: submodule.*.branch config is keyed by name

Merge branch 'wt/doc-submodule-name-path-confusion-1'

2014-03-31T23:31:14Z

* wt/doc-submodule-name-path-confusion-1: doc: submodule.* config are keyed by submodule names

doc: submodule.*.branch config is keyed by name

2014-03-27T22:01:42Z

Ever since 941987a5 (git-submodule: give submodules proper names, 2007-06-11) introduced the ability to move a submodule from one path to another inside its superproject tree without losing its identity, we should have consistently used submodule..* to access settings related to the named submodule. Signed-off-by: W. Trevor King Signed-off-by: Junio C Hamano

doc: submodule.* config are keyed by submodule names

2014-03-27T21:58:37Z

Ever since 941987a5 (git-submodule: give submodules proper names, 2007-06-11) introduced the ability to move a submodule from one path to another inside its superproject tree without losing its identity, we should have consistently used submodule..* to access settings related to the named submodule. Reported-by: Junio C Hamano Signed-off-by: W. Trevor King Signed-off-by: Junio C Hamano