Date: Sun, 19 Apr 2020 01:22:28 +0700 From: Eugene Grosbein <eugen@grosbein.net> To: Poul-Henning Kamp <phk@phk.freebsd.dk>, hackers@freebsd.org Subject: Re: orphan .Xr in manual pages Message-ID: <430119cd-2ef1-75c8-4922-c9f47d026880@grosbein.net> In-Reply-To: <30493.1586018580@critter.freebsd.dk> References: <30493.1586018580@critter.freebsd.dk>
next in thread | previous in thread | raw e-mail | index | archive | help
04.04.2020 23:43, Poul-Henning Kamp пишет:
> I saw opencsd flitter by in the output of buildworld, so I did
> apropos(1), found tcsd(8) which cross-references to tcsd.conf(5)
> which doesn't seem to get installed.
>
> Similar annoyances have happened a couple of times in recent
> months, so while I waited for the buildworld to complete, I
> threw together a small script to report orphan .Xr's in the
> manual pages (attached).
>
> It transpires we have a lot of those, and from basic principles
> of POLA, that is bad.
>
> Some of them are typo-ish, Xr'ing zfs(1) instead of zfs(8)
>
> Some of them point to stuff in ports, for instance dma(8) -> postfix(1),
> which I guess is semi-sensible, but maybe they should say which port ?
>
> But a LOT of them are simply bogus.
>
> List from a pretty virgin 12.1 system here:
[skip]
> ./man8/mdconfig.8 .Xr vnconfig 8 not found
How should we deal with similar historic cases?
HISTORY
The mdconfig utility first appeared in FreeBSD 5.0 as a cleaner
replacement for the vn(4) and vnconfig(8) combo.
For now, vn(4) is an alias for md(4) and vnconfig(8) is an alias for mdconfig(8),
so they are not exactly "broken links".
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?430119cd-2ef1-75c8-4922-c9f47d026880>