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

From: Matthieu Moy <matthieu.moy@grenoble-inp.fr>
Date: Sep 16, 2012, 12:08 UTC
Message-ID: <vpqsjaiyxth.fsf@grenoble-inp.fr>
In-Reply-To: <1347793083-4136-8-git-send-email-philipoakley@iee.org>

Philip Oakley <philipoakley@iee.org> writes:

Show 11 quoted lines

> --- 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 ...

-- 
Matthieu Moy
http://www-verimag.imag.fr/~moy/