From owner-freebsd-doc@FreeBSD.ORG Tue Apr 29 10:33: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 731E037B401; Tue, 29 Apr 2003 10:33:27 -0700 (PDT) Received: from whale.sunbay.crimea.ua (whale.sunbay.crimea.ua [212.110.138.65]) by mx1.FreeBSD.org (Postfix) with ESMTP id 8161443F3F; Tue, 29 Apr 2003 10:33:23 -0700 (PDT) (envelope-from ru@whale.sunbay.crimea.ua) Received: from whale.sunbay.crimea.ua (ru@localhost [127.0.0.1]) h3THXH62057582 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO); Tue, 29 Apr 2003 20:33:18 +0300 (EEST) (envelope-from ru@whale.sunbay.crimea.ua) Received: (from ru@localhost) by whale.sunbay.crimea.ua (8.12.9/8.12.8/Submit) id h3THXHnf057581; Tue, 29 Apr 2003 20:33:17 +0300 (EEST) (envelope-from ru) Date: Tue, 29 Apr 2003 20:33:17 +0300 From: Ruslan Ermilov To: Tom Rhodes Message-ID: <20030429173317.GA56779@sunbay.com> References: <20030424233703.GB48527@nitro.dk> <20030425202427.GC28920@sunbay.com> <20030426103416.GA407@nitro.dk> <20030426113227.GC9189@sunbay.com> <20030428232915.67cccaa8.trhodes@FreeBSD.org> Mime-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="5mCyUwZo2JvN/JJP" Content-Disposition: inline In-Reply-To: <20030428232915.67cccaa8.trhodes@FreeBSD.org> User-Agent: Mutt/1.5.4i 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 17:33:27 -0000 --5mCyUwZo2JvN/JJP Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Mon, Apr 28, 2003 at 11:29:15PM -0400, Tom Rhodes wrote: > On Sat, 26 Apr 2003 14:32:27 +0300 > Ruslan Ermilov wrote: >=20 > > 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: > > >=20 > > > > 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 mu= ch to > > > > expect to happen, methinks. Also, to avoid the need to handle the > > > > PRs that will then be (eventually) written after nearly every chang= e. > > > >=20 > > > > As for the SGML, the same thing applies, but I suspect it's too har= d 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 anyo= ne > > > > who can't guess it. > > >=20 > > > 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. > > >=20 > > > If the category is not there it would also make it harder to make lin= ks > > > to the port e.g. in man.cgi. > > >=20 > > > 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. > > >=20 > > 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. > >=20 >=20 > So, are we going to work on this? >=20 We already do. The only thing I miss is how people would like it to be rendered, and I just need more opinions (more voices). I hoped that ports@ and doc@ (not necessarily committers) developers would suggest something, or agree on the proposed one. > Perhaps this should be thrown at doceng? >=20 Not needed; doceng is not for this sort of things and would like such discussions to take place in doc@. With my doceng@ hat on, --=20 Ruslan Ermilov Sysadmin and DBA, ru@sunbay.com Sunbay Software AG, ru@FreeBSD.org FreeBSD committer, +380.652.512.251 Simferopol, Ukraine http://www.FreeBSD.org The Power To Serve http://www.oracle.com Enabling The Information Age --5mCyUwZo2JvN/JJP Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.2.1 (FreeBSD) iD8DBQE+rrddUkv4P6juNwoRAppaAJsGIy4TJfUq36yuQAHvXvDAhaS1qQCfayaJ eG1dLmQcXPibugcQnpO33rI= =egso -----END PGP SIGNATURE----- --5mCyUwZo2JvN/JJP--