> On Mar 15, 2017, at 21:00, Bruce Evans <b...@optusnet.com.au> wrote: > > On Thu, 16 Mar 2017, Ngie Cooper wrote: > >> Log: >> Tweak r315363 slightly >> >> I noticed after commit that kvm_dpcpu_setcpu was defined in the manpage. >> Thus, the correct macro for the function reference is .Fn, not .Xr. > > Is .Xr ever correct for a function? I think it names man pages, not > functions, and only the higher-quality man pages document only 1 > function and have the same name as that function. Rendering might be > different for function. > > I don't like generic .Xr's. They often point to very large man pages > with relevant 1 clause in sentence, and no hint about what this clause > might say or how to find it. Generic .Xr's are typically found in the > main .Xr section, with no hints about how they are relevant to the > current man page either. Ones in other sections at least have some > nearby context. > > Naming functions in other pages is actually more useful than naming > the man page containing them. Then you can grep for clauses containing > the function name.
Hi Bruce,
In this case, the .Xr was incorrect, since it was self-referential; .Fn
was the right answer for the second part of r315363.
Thanks,
-Ngie
signature.asc
Description: Message signed with OpenPGP using GPGMail
