{"thread":{"id":"31547","subject":"[PATCH 7/8] Doc clean: add See Also links","startedAt":"2012-09-16T10:58:02Z","lastAt":"2012-09-17T22:19:33Z","messageCount":6,"participants":["Philip Oakley","Matthieu Moy","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":8},"messages":[{"id":"199145","messageId":"1347793083-4136-8-git-send-email-philipoakley@iee.org","threadId":"31547","inReplyTo":null,"subject":"[PATCH 7/8] Doc clean: add See Also links","fromName":"Philip Oakley","fromEmail":"philipoakley@iee.org","sentAt":"2012-09-16T10:58:02Z","receivedAt":"2012-09-16T10:58:02Z","isPatch":true,"sender":{"key":"philipoakley@iee.email","avatar":"https://avatars.githubusercontent.com/u/914343?v=4"},"body":"'git clean' is controlled by gitignore, excludes,\nand core.excludesfile. Provide See Also links for them.\n\nUse of core.excludesfile is implied.\n\nSigned-off-by: Philip Oakley \n\ndiff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt\nindex 79fb984..9a977b7 100644\n--- a/Documentation/git-clean.txt\n+++ b/Documentation/git-clean.txt\n@@ -63,6 +63,12 @@ OPTIONS\n \tRemove only files ignored by git. This may be useful to rebuild\n \teverything from scratch, but keep manually created files.\n \n+SEE ALSO\n+--------\n+linkgit:gitignore[5]\n+linkgit:gitrepository-layout[5]\n+The optional configuration variable `core.excludesfile` linkgit:git-config[1]\n+\n GIT\n ---\n Part of the linkgit:git[1] suite\n-- \n1.7.8.msysgit.0\n"},{"id":"199150","messageId":"vpqsjaiyxth.fsf@grenoble-inp.fr","threadId":"31547","inReplyTo":"1347793083-4136-8-git-send-email-philipoakley@iee.org","subject":"Re: [PATCH 7/8] Doc clean: add See Also links","fromName":"Matthieu Moy","fromEmail":"matthieu.moy@grenoble-inp.fr","sentAt":"2012-09-16T12:08:42Z","receivedAt":"2012-09-16T12:08:42Z","isPatch":true,"sender":{"key":"matthieu.moy@grenoble-inp.fr","avatar":"https://gravatar.com/avatar/72c8a2705971a25dfaff23cece15130d405685845d911aedd5667ace277f3fc5?d=mp&s=160"},"body":"Philip Oakley writes:\n\n> --- a/Documentation/git-clean.txt\n> +++ b/Documentation/git-clean.txt\n> @@ -63,6 +63,12 @@ OPTIONS\n> \tRemove only files ignored by git. This may be useful to rebuild\n> \teverything from scratch, but keep manually created files.\n> \n> +SEE ALSO\n> +--------\n> +linkgit:gitignore[5]\n> +linkgit:gitrepository-layout[5]\n> +The optional configuration variable `core.excludesfile` linkgit:git-config[1]\n\nI think linkgit:gitignore[5] is enough. linkgit:gitrepository-layout[5]\nis a very general documentation, it's not clear to the reader which part\nis intended to be read in complement to git-clean, and indeed, the\nrelevant information is already in linkgit:gitignore[5]. Same for\ncore.excludesfile which is already documented in linkgit:gitignore[5].\n\nOtherwise, I suspect we'll end-up having the transitive closure of SEE\nALSO in each manpage ...\n\n-- \nMatthieu Moy\nhttp://www-verimag.imag.fr/~moy/\n"},{"id":"199175","messageId":"5056269F.3070708@iee.org","threadId":"31547","inReplyTo":"vpqsjaiyxth.fsf@grenoble-inp.fr","subject":"Re: [PATCH 7/8] Doc clean: add See Also links","fromName":"Philip Oakley","fromEmail":"philipoakley@iee.org","sentAt":"2012-09-16T19:21:03Z","receivedAt":"2012-09-16T19:21:03Z","isPatch":true,"sender":{"key":"philipoakley@iee.email","avatar":"https://avatars.githubusercontent.com/u/914343?v=4"},"body":"On 16/09/12 13:08, Matthieu Moy wrote:\n> Philip Oakley writes:\n>\n>> --- a/Documentation/git-clean.txt\n>> +++ b/Documentation/git-clean.txt\n>> @@ -63,6 +63,12 @@ OPTIONS\n>> \tRemove only files ignored by git. This may be useful to rebuild\n>> \teverything from scratch, but keep manually created files.\n>> \n>> +SEE ALSO\n>> +--------\n>> +linkgit:gitignore[5]\n>> +linkgit:gitrepository-layout[5]\n>> +The optional configuration variable `core.excludesfile` linkgit:git-config[1]\n> I think linkgit:gitignore[5] is enough. linkgit:gitrepository-layout[5]\n> is a very general documentation, it's not clear to the reader which part\n> is intended to be read in complement to git-clean, and indeed, the\n> relevant information is already in linkgit:gitignore[5]. Same for\n> core.excludesfile which is already documented in linkgit:gitignore[5].\n>\n> Otherwise, I suspect we'll end-up having the transitive closure of SEE\n> ALSO in each manpage ...\nI'd added all three partly because of the git add link which went first \nto the repository layout which didn't help me much without the extra link.\n\nIn fact I've lost a patch (a mistaken rebase todo list possibly) to make \nthe three git ignore pattern types more obvious in the documentation, \nwhich would probably cover your point.\n"},{"id":"199177","messageId":"50563047.5040103@iee.org","threadId":"31547","inReplyTo":"5056269F.3070708@iee.org","subject":"Re: [PATCH 7/8] Doc clean: add See Also links","fromName":"Philip Oakley","fromEmail":"philipoakley@iee.org","sentAt":"2012-09-16T20:02:15Z","receivedAt":"2012-09-16T20:02:15Z","isPatch":true,"sender":{"key":"philipoakley@iee.email","avatar":"https://avatars.githubusercontent.com/u/914343?v=4"},"body":"On 16/09/12 20:21, Philip Oakley wrote:\n> On 16/09/12 13:08, Matthieu Moy wrote:\n>> Philip Oakley writes:\n>>\n>>> --- a/Documentation/git-clean.txt\n>>> +++ b/Documentation/git-clean.txt\n>>> @@ -63,6 +63,12 @@ OPTIONS\n>>> Remove only files ignored by git. This may be useful to rebuild\n>>> everything from scratch, but keep manually created files.\n>>> +SEE ALSO\n>>> +--------\n>>> +linkgit:gitignore[5]\n>>> +linkgit:gitrepository-layout[5]\n>>> +The optional configuration variable `core.excludesfile`\n>>> linkgit:git-config[1]\n>> I think linkgit:gitignore[5] is enough. \n>\n> In fact I've lost a patch (a mistaken rebase todo list possibly) to\n> make the three git ignore pattern types more obvious in the\n> documentation, which would probably cover your point.\nFalse alarm. It was patch 5/8, with the spelling mistake. sorry.\n"},{"id":"199183","messageId":"7vboh5xmyn.fsf@alter.siamese.dyndns.org","threadId":"31547","inReplyTo":"vpqsjaiyxth.fsf@grenoble-inp.fr","subject":"Re: [PATCH 7/8] Doc clean: add See Also links","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2012-09-17T05:00:48Z","receivedAt":"2012-09-17T05:00:48Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Matthieu Moy writes:\n\n> Philip Oakley writes:\n>\n>> --- a/Documentation/git-clean.txt\n>> +++ b/Documentation/git-clean.txt\n>> @@ -63,6 +63,12 @@ OPTIONS\n>> \tRemove only files ignored by git. This may be useful to rebuild\n>> \teverything from scratch, but keep manually created files.\n>> \n>> +SEE ALSO\n>> +--------\n>> +linkgit:gitignore[5]\n>> +linkgit:gitrepository-layout[5]\n>> +The optional configuration variable `core.excludesfile` linkgit:git-config[1]\n>\n> I think linkgit:gitignore[5] is enough. linkgit:gitrepository-layout[5]\n> is a very general documentation, it's not clear to the reader which part\n> is intended to be read in complement to git-clean, and indeed, the\n> relevant information is already in linkgit:gitignore[5]. Same for\n> core.excludesfile which is already documented in linkgit:gitignore[5].\n>\n> Otherwise, I suspect we'll end-up having the transitive closure of SEE\n> ALSO in each manpage ...\n\nConcurred. Thanks.\n"},{"id":"199302","messageId":"E8ECAAA8437C417DA26A2BD673D54903@PhilipOakley","threadId":"31547","inReplyTo":"7vboh5xmyn.fsf@alter.siamese.dyndns.org","subject":"Re: [PATCH 7/8] Doc clean: add See Also links","fromName":"Philip Oakley","fromEmail":"philipoakley@iee.org","sentAt":"2012-09-17T22:19:33Z","receivedAt":"2012-09-17T22:19:33Z","isPatch":true,"sender":{"key":"philipoakley@iee.email","avatar":"https://avatars.githubusercontent.com/u/914343?v=4"},"body":"From: \"Junio C Hamano\" \n> Matthieu Moy writes:\n>\n>> Philip Oakley writes:\n>>\n>>> --- a/Documentation/git-clean.txt\n>>> +++ b/Documentation/git-clean.txt\n>>> @@ -63,6 +63,12 @@ OPTIONS\n>>> Remove only files ignored by git. This may be useful to rebuild\n>>> everything from scratch, but keep manually created files.\n>>>\n>>> +SEE ALSO\n>>> +--------\n>>> +linkgit:gitignore[5]\n>>> +linkgit:gitrepository-layout[5]\n>>> +The optional configuration variable `core.excludesfile` \n>>> linkgit:git-config[1]\n>>\n>> I think linkgit:gitignore[5] is enough. \n>> linkgit:gitrepository-layout[5]\n>> is a very general documentation, it's not clear to the reader which \n>> part\n>> is intended to be read in complement to git-clean, and indeed, the\n>> relevant information is already in linkgit:gitignore[5]. Same for\n>> core.excludesfile which is already documented in \n>> linkgit:gitignore[5].\n>>\n>> Otherwise, I suspect we'll end-up having the transitive closure of \n>> SEE\n>> ALSO in each manpage ...\n>\n> Concurred. Thanks.\n> --\nThe improved layout of gitignore in patch 5/8 should cover it. The three \nlinks came about because of the initial 'git add' patch 6/8.\n\nI'll update (though probably tomorrow night..). \n"}]}