From owner-freebsd-doc@FreeBSD.ORG Tue Apr 29 08:39:27 2003 Return-Path: Delivered-To: freebsd-doc@freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id D75DF37B401; Tue, 29 Apr 2003 08:39:27 -0700 (PDT) Received: from pittgoth.com (14.zlnp1.xdsl.nauticom.net [209.195.149.111]) by mx1.FreeBSD.org (Postfix) with ESMTP id E1FE943FCB; Tue, 29 Apr 2003 08:39:26 -0700 (PDT) (envelope-from trhodes@FreeBSD.org) Received: from mobile.pittgoth.com (acs-24-154-229-196.zoominternet.net [24.154.229.196]) by pittgoth.com (8.12.9/8.12.9) with SMTP id h3TFdPZK062515; Tue, 29 Apr 2003 11:39:25 -0400 (EDT) (envelope-from trhodes@FreeBSD.org) Date: Mon, 28 Apr 2003 23:29:15 -0400 From: Tom Rhodes To: Ruslan Ermilov Message-Id: <20030428232915.67cccaa8.trhodes@FreeBSD.org> In-Reply-To: <20030426113227.GC9189@sunbay.com> References: <20030424233703.GB48527@nitro.dk> <20030425202427.GC28920@sunbay.com> <20030426103416.GA407@nitro.dk> <20030426113227.GC9189@sunbay.com> X-Mailer: Sylpheed version 0.8.10claws (GTK+ 1.2.10; i386-portbld-freebsd5.0) Mime-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit cc: simon@nitro.dk cc: freebsd-doc@FreeBSD.org Subject: Re: .Xr references to ports in man pages X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 29 Apr 2003 15:39:28 -0000 On Sat, 26 Apr 2003 14:32:27 +0300 Ruslan Ermilov wrote: > On Sat, Apr 26, 2003 at 12:34:17PM +0200, Simon L. Nielsen wrote: > > On 2003.04.25 16:46:18 -0700, Gary W. Swearingen wrote: > > > > > To avoid having erroneous information in the manpages before someone > > > discovers that the category has been changed without the changer > > > remembering and/or bothering to search all the manpages and fix all the > > > unnecessary category references which have gone bad. That's too much to > > > expect to happen, methinks. Also, to avoid the need to handle the > > > PRs that will then be (eventually) written after nearly every change. > > > > > > As for the SGML, the same thing applies, but I suspect it's too hard to > > > fix in the SGML processing, but I recommend easing SGML maintenance by > > > omitting the "CATEGORY/". There's too much more useful stuff to > > > maintain, as it is, and "whereis" easily gives the category to anyone > > > who can't guess it. > > > > Is this really a big problem? I't not that often ports get moved and > > since there is ports/MOVED it is very easy to use a script to once in a > > while automatically go through the references in the documentation and > > fix the references. > > > > If the category is not there it would also make it harder to make links > > to the port e.g. in man.cgi. > > > > That being said if others feel it is better to not specify ports it OK > > with me. I mainly want to get rid of "bad" references. > > > Not, it's not OK with others. Writing a simple script that finds > all port references and checks this with the fresh ports/ tree is > not that hard. I've been planning on setting the manpages tinder > box; adding this feature to it would be trivial. > So, are we going to work on this? I've got a PR which I'll gladly work on which shows .Xr refs to ports manual pages. I don't want to just remove the ref, yet I don't want it to stay there either. Perhaps this should be thrown at doceng? -- Tom Rhodes