Re: [PATCH] link to gitmodules page at the beginning of git-submoduledocumentation

> This way the user does not have to scroll down to the bottom to find
> it.
>
> Signed-off-by: Heiko Voigt <hvoigt@hvoigt.net>
> ---
> On Thu, May 10, 2012 at 09:30:12PM +0100, Philip Oakley wrote:
>> From: "Heiko Voigt" <hvoigt@hvoigt.net> Sent: Thursday, May 10, 2012 7:59 PM
>>> This option was not yet described in the gitmodules documentation. We
>>> only described it in the 'git submodule' command documentation but
>>> gitmodules is the more natural place to look.
>>
>> The gitmodules documentation is only more natural if we tell (link) the
>> reader early in the submodule documentation. A link to gitmodules should
>> be provided in the third paragraph of Description where the .gitmodules
>> is introduced.
>>
>> Currently the gitmodules link is the last thing mentioned (i.e. 8 PgDn's for me).
>
> The gitmodules documentation page describes all the options you can use
> there so its by definition more natural. Yes I can see that a link to
> gitmodules page could be provided earlier but thats a completely
> different topic independent from my previous patch. Instead of
> complaining how about providing a patch next time?

>
> Anyway here we go...
>
> Documentation/git-submodule.txt | 6 +++---
> 1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
> index c83a856..9e488c0 100644
> --- a/Documentation/git-submodule.txt
> +++ b/Documentation/git-submodule.txt
> @@ -43,9 +43,9 @@ if you choose to go that route.
> Submodules are composed from a so-called `gitlink` tree entry
> in the main repository that refers to a particular commit object
> within the inner repository that is completely separate.
> -A record in the `.gitmodules` file at the root of the source
> -tree assigns a logical name to the submodule and describes
> -the default URL the submodule shall be cloned from.
> +A record in the `.gitmodules` (see linkgit:gitmodules[5]) file at the
> +root of the source tree assigns a logical name to the submodule and
> +describes the default URL the submodule shall be cloned from.
> The logical name can be used for overriding this URL within your
> local repository configuration (see 'submodule init').
>
> -- 
> 1.7.10.1.488.ga84c0c8
>
>
>
> -----