On Sun, Apr 28, 2019 at 02:16:23PM -0500, Tim Chase wrote:
> Digging through cross-references in man-pages, I encountered a couple
> dangling references and some other peculiarities.
> 

hi.

because we sometimes install 3rd party pages, there is a small amount of
Xr that doesn;t match up. the effort to clean it up is probably not
worth it.

> 
> Dangling SEE ALSO references to man-pages that don't exist:
> 
> dig(1) references missing named(8) and dnssec-keygen(8)
> host(1) references missing named(8)
> nslookup(1) references missing named(8)

that's all from bind

> info(5) references missing emacs(1)
> info(5) references missing tex(1)
> texinfo(5) references missing emacs(1)
> texinfo(5) references missing tex(1)

boy do i wish we could kill the info crap.

> default_colors(3) references missing ded(1)
> curs_inopts(3) references missing termio(7)

curses

> readline(3) references missing bash(1)
> 

gnu readline (check the "ouput" typo)

basically, upstream will not see these as issues, and maintaing local
changes are often more pain that gain.

> Peculiarities:
> 
> The man pages for form(3) and menu(3) have multiple SEE ALSO sections
> which struck me as a bit odd/confusing.  
> 
>

i've never noticed that. you could check if the latest curses still has
this - if they do, they are quite receptive to diffs. if not, we could
ask someone like nicm about fixing this locally.

> It all started with looking at texinfo(5) and noticing that tex(1)
> didn't exist in the man-pages, so I tossed together a dirty little
> Python script to attempt to check for other missing cross-references.
> The script still produces a little bit of noise in the output that I
> cleaned up for this email, but it made pretty quick work of finding
> some missing links.  If anybody wants the .py file, you're welcome to
> it.
> 

better still, run any changes you make to man pages like this:

        $ mandoc -Tlint page.1

it will report trailing Xr and a whole host of other things. you can sit
back and have a cuppa!

jmc

Reply via email to