* [PATCH 7/8] Doc clean: add See Also links
@ 2012-09-16 10:58 Philip Oakley
2012-09-16 12:08 ` Matthieu Moy
0 siblings, 1 reply; 6+ messages in thread
From: Philip Oakley @ 2012-09-16 10:58 UTC (permalink / raw)
To: gitList
'git clean' is controlled by gitignore, excludes,
and core.excludesfile. Provide See Also links for them.
Use of core.excludesfile is implied.
Signed-off-by: Philip Oakley <philipoakley@iee.org>
diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt
index 79fb984..9a977b7 100644
--- 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]
+
GIT
---
Part of the linkgit:git[1] suite
--
1.7.8.msysgit.0
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCH 7/8] Doc clean: add See Also links
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
2012-09-17 5:00 ` Junio C Hamano
0 siblings, 2 replies; 6+ messages in thread
From: Matthieu Moy @ 2012-09-16 12:08 UTC (permalink / raw)
To: Philip Oakley; +Cc: gitList
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 ...
--
Matthieu Moy
http://www-verimag.imag.fr/~moy/
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH 7/8] Doc clean: add See Also links
2012-09-16 12:08 ` Matthieu Moy
@ 2012-09-16 19:21 ` Philip Oakley
2012-09-16 20:02 ` Philip Oakley
2012-09-17 5:00 ` Junio C Hamano
1 sibling, 1 reply; 6+ messages in thread
From: Philip Oakley @ 2012-09-16 19:21 UTC (permalink / raw)
To: Matthieu Moy; +Cc: gitList
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.
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH 7/8] Doc clean: add See Also links
2012-09-16 19:21 ` Philip Oakley
@ 2012-09-16 20:02 ` Philip Oakley
0 siblings, 0 replies; 6+ messages in thread
From: Philip Oakley @ 2012-09-16 20:02 UTC (permalink / raw)
To: Matthieu Moy; +Cc: gitList
On 16/09/12 20:21, Philip Oakley wrote:
> 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. <snip>
>
> 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.
False alarm. It was patch 5/8, with the spelling mistake. sorry.
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH 7/8] Doc clean: add See Also links
2012-09-16 12:08 ` Matthieu Moy
2012-09-16 19:21 ` Philip Oakley
@ 2012-09-17 5:00 ` Junio C Hamano
2012-09-17 22:19 ` Philip Oakley
1 sibling, 1 reply; 6+ messages in thread
From: Junio C Hamano @ 2012-09-17 5:00 UTC (permalink / raw)
To: Matthieu Moy; +Cc: Philip Oakley, gitList
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.
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH 7/8] Doc clean: add See Also links
2012-09-17 5:00 ` Junio C Hamano
@ 2012-09-17 22:19 ` Philip Oakley
0 siblings, 0 replies; 6+ messages in thread
From: Philip Oakley @ 2012-09-17 22:19 UTC (permalink / raw)
To: Junio C Hamano, Matthieu Moy; +Cc: gitList
From: "Junio C Hamano" <gitster@pobox.com>
> 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..).
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2012-09-17 22:19 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
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
2012-09-16 20:02 ` Philip Oakley
2012-09-17 5:00 ` Junio C Hamano
2012-09-17 22:19 ` Philip Oakley
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).