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

2 messages, 2 authors, 2016-06-15 · open the first message on its own page

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

From: Junio C Hamano <hidden>
Date: 2016-06-15 22:54:46

Matthieu Moy [off-list ref] writes:
Philip Oakley [off-list ref] writes:
quoted
--- 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.

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

From: Philip Oakley <hidden>
Date: 2016-06-15 22:54:47

From: "Junio C Hamano" <redacted>
Matthieu Moy [off-list ref] writes:
quoted
Philip Oakley [off-list ref] writes:
quoted
--- 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..). 
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help