Re: [PATCH 7/8] Doc clean: add See Also links

From: Philip Oakley <philipoakley@iee.org>
Date: Sep 17, 2012, 22:19 UTC
Message-ID: <E8ECAAA8437C417DA26A2BD673D54903@PhilipOakley>
In-Reply-To: <7vboh5xmyn.fsf@alter.siamese.dyndns.org>

From: "Junio C Hamano" <gitster@pobox.com>

Show 32 quoted lines

> Matthieu Moy <Matthieu.Moy@grenoble-inp.fr> writes:
>
>> Philip Oakley <philipoakley@iee.org> writes:
>>
>>> --- a/Documentation/git-clean.txt
>>> +++ b/Documentation/git-clean.txt
>>> @@ -63,6 +63,12 @@ OPTIONS
>>>  Remove only files ignored by git.  This may be useful to rebuild
>>>  everything from scratch, but keep manually created files.
>>>
>>> +SEE ALSO
>>> +--------
>>> +linkgit:gitignore[5]
>>> +linkgit:gitrepository-layout[5]
>>> +The optional configuration variable `core.excludesfile` 
>>> linkgit:git-config[1]
>>
>> I think linkgit:gitignore[5] is enough. 
>> linkgit:gitrepository-layout[5]
>> is a very general documentation, it's not clear to the reader which 
>> part
>> is intended to be read in complement to git-clean, and indeed, the
>> relevant information is already in linkgit:gitignore[5]. Same for
>> core.excludesfile which is already documented in 
>> linkgit:gitignore[5].
>>
>> Otherwise, I suspect we'll end-up having the transitive closure of 
>> SEE
>> ALSO in each manpage ...
>
> Concurred.  Thanks.
> --

The improved layout of gitignore in patch 5/8 should cover it. The three links came about because of the initial 'git add' patch 6/8.

I'll update (though probably tomorrow night..).