From mboxrd@z Thu Jan 1 00:00:00 1970 From: Philip Oakley Subject: Re: [PATCH 7/8] Doc clean: add See Also links Date: Sun, 16 Sep 2012 20:21:03 +0100 Message-ID: <5056269F.3070708@iee.org> References: <1347793083-4136-8-git-send-email-philipoakley@iee.org> Mime-Version: 1.0 Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit Cc: gitList To: Matthieu Moy X-From: git-owner@vger.kernel.org Sun Sep 16 21:21:18 2012 Return-path: Envelope-to: gcvg-git-2@plane.gmane.org Received: from vger.kernel.org ([209.132.180.67]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1TDKP7-0008Lj-Sx for gcvg-git-2@plane.gmane.org; Sun, 16 Sep 2012 21:21:18 +0200 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751648Ab2IPTVH (ORCPT ); Sun, 16 Sep 2012 15:21:07 -0400 Received: from out1.ip02ir2.opaltelecom.net ([62.24.128.238]:38242 "EHLO out1.ip02ir2.opaltelecom.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751055Ab2IPTVG (ORCPT ); Sun, 16 Sep 2012 15:21:06 -0400 X-IronPort-Anti-Spam-Filtered: true X-IronPort-Anti-Spam-Result: ApMBAFElVlBZ8rU+/2dsb2JhbAANOL85AQEBAQM4QAEQCxgJFg8JAwIBAgFFBg0BBQIBAa53kl6SCQOoag X-IronPort-AV: E=Sophos;i="4.80,431,1344207600"; d="scan'208";a="403502480" Received: from host-89-242-181-62.as13285.net (HELO [192.168.0.9]) ([89.242.181.62]) by out1.ip02ir2.opaltelecom.net with ESMTP; 16 Sep 2012 20:21:04 +0100 User-Agent: Mozilla/5.0 (X11; Linux i686; rv:15.0) Gecko/20120827 Thunderbird/15.0 In-Reply-To: Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Archived-At: 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.