# [PATCH 7/8] Doc clean: add See Also links 6 messages from 2012-09-16 to 2012-09-17. Participants: Philip Oakley, Matthieu Moy, Junio C Hamano. Thread: https://gitlist.dev/t/31547 ## Philip Oakley, 2012-09-16 10:58 Subject: [PATCH 7/8] Doc clean: add See Also links Message-ID: <1347793083-4136-8-git-send-email-philipoakley@iee.org> URL: https://gitlist.dev/e/1347793083-4136-8-git-send-email-philipoakley%40iee.org ``` '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 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 ``` ## Matthieu Moy, 2012-09-16 12:08 Subject: Re: [PATCH 7/8] Doc clean: add See Also links Message-ID: URL: https://gitlist.dev/e/vpqsjaiyxth.fsf%40grenoble-inp.fr In-Reply-To: <1347793083-4136-8-git-send-email-philipoakley@iee.org> ``` Philip Oakley 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/ ``` ## Philip Oakley, 2012-09-16 19:21 Subject: Re: [PATCH 7/8] Doc clean: add See Also links Message-ID: <5056269F.3070708@iee.org> URL: https://gitlist.dev/e/5056269F.3070708%40iee.org In-Reply-To: ``` On 16/09/12 13:08, Matthieu Moy wrote: > Philip Oakley 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. ``` ## Philip Oakley, 2012-09-16 20:02 Subject: Re: [PATCH 7/8] Doc clean: add See Also links Message-ID: <50563047.5040103@iee.org> URL: https://gitlist.dev/e/50563047.5040103%40iee.org In-Reply-To: <5056269F.3070708@iee.org> ``` On 16/09/12 20:21, Philip Oakley wrote: > On 16/09/12 13:08, Matthieu Moy wrote: >> Philip Oakley 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. > > 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. ``` ## Junio C Hamano, 2012-09-17 05:00 Subject: Re: [PATCH 7/8] Doc clean: add See Also links Message-ID: <7vboh5xmyn.fsf@alter.siamese.dyndns.org> URL: https://gitlist.dev/e/7vboh5xmyn.fsf%40alter.siamese.dyndns.org In-Reply-To: ``` Matthieu Moy writes: > Philip Oakley 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. ``` ## Philip Oakley, 2012-09-17 22:19 Subject: Re: [PATCH 7/8] Doc clean: add See Also links Message-ID: URL: https://gitlist.dev/e/E8ECAAA8437C417DA26A2BD673D54903%40PhilipOakley In-Reply-To: <7vboh5xmyn.fsf@alter.siamese.dyndns.org> ``` From: "Junio C Hamano" > Matthieu Moy writes: > >> Philip Oakley 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..). ```