From: Philip Oakley <philipoakley@iee.org>
To: Matthieu Moy <Matthieu.Moy@grenoble-inp.fr>
Cc: gitList <git@vger.kernel.org>
Subject: Re: [PATCH 7/8] Doc clean: add See Also links
Date: Sun, 16 Sep 2012 20:21:03 +0100 [thread overview]
Message-ID: <5056269F.3070708@iee.org> (raw)
In-Reply-To: <vpqsjaiyxth.fsf@grenoble-inp.fr>
On 16/09/12 13:08, Matthieu Moy wrote:
> 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 ...
I'd added all three partly because of the git add link which went first
to the repository layout which didn't help me much without the extra link.
In fact I've lost a patch (a mistaken rebase todo list possibly) to make
the three git ignore pattern types more obvious in the documentation,
which would probably cover your point.
next prev parent reply other threads:[~2012-09-16 19:21 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-09-16 10:58 [PATCH 7/8] Doc clean: add See Also links Philip Oakley
2012-09-16 12:08 ` Matthieu Moy
2012-09-16 19:21 ` Philip Oakley [this message]
2012-09-16 20:02 ` Philip Oakley
2012-09-17 5:00 ` Junio C Hamano
2012-09-17 22:19 ` Philip Oakley
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=5056269F.3070708@iee.org \
--to=philipoakley@iee.org \
--cc=Matthieu.Moy@grenoble-inp.fr \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).