.Xr references to ports in man pages

[Tom Rhodes]

On Sat, 26 Apr 2003 14:32:27 +0300
Ruslan Ermilov <ru at freebsd.org> 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