.Xr references to ports in man pages

Simon L. Nielsen simon at nitro.dk
Sat Apr 26 10:34:21 UTC 2003


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.

-- 
Simon L. Nielsen
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 187 bytes
Desc: not available
URL: <http://lists.freebsd.org/pipermail/freebsd-doc/attachments/20030426/9f673dd5/attachment.sig>


More information about the freebsd-doc mailing list