From: Philip Oakley <philipoakley@iee.org>
Date: Mon, 17 Sep 2012 22:01:30 GMT
Subject: Re: [PATCH 6/8] Doc add: link gitignore
Message-ID: <6AB419E032004F8A890B01EC04731CD2@PhilipOakley>
In-Reply-To: <7vhaqxw635.fsf@alter.siamese.dyndns.org>

From: "Junio C Hamano" <gitster@pobox.com>
> Philip Oakley <philipoakley@iee.org> writes:
>
>> Include the gitignore link with the paired gitrepository-
>> layout link.
>>
>> Signed-off-by: Philip Oakley <philipoakley@iee.org>
>> ---
>>
>> without the gitignore link users are unlikely to realise the
>> significance of the repository layout link, nor what to look for
>> within it
>>
>> diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt
>> index 9c1d395..311be9a 100644
>> --- a/Documentation/git-add.txt
>> +++ b/Documentation/git-add.txt
>> @@ -155,7 +155,8 @@ Configuration
>>  The optional configuration variable `core.excludesfile` indicates a 
>> path to a
>>  file containing patterns of file names to exclude from git-add, 
>> similar to
>>  $GIT_DIR/info/exclude.  Patterns in the exclude file are used in 
>> addition to
>> -those in info/exclude.  See linkgit:gitrepository-layout[5].
>> +those in info/exclude.  See linkgit:gitrepository-layout[5] and
>> +linkgit:gitignore[5].
>
> A reader of git-add shouldn't have to refer to gitrepository-layout[5]
> in the first place when we talk about "add $pathspec" may ignore
> paths that are configured to be ignored.  gitignore[5] should give
> everything necessary to him.

True. Now that 5/8 makes the details in gitignore clearer it should be 
OK to change from linking repository layout to the gitignor page.
>
> This section (even before the precontext we can see in the patch)
> may need a bit larger rewrite so that it just refers to gitignore[5]
> and leave the details of where the exclude information comes to that
> manual page.

I'll see if I can do something on that as a separate patch.

Philip