Date: Thu, 16 Mar 2017 15:00:14 +1100 (EST) From: Bruce Evans <brde@optusnet.com.au> To: Ngie Cooper <ngie@freebsd.org> Cc: src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org Subject: Re: svn commit: r315365 - head/lib/libkvm Message-ID: <20170316144923.O1839@besplex.bde.org> In-Reply-To: <201703160324.v2G3OFHh004812@repo.freebsd.org> References: <201703160324.v2G3OFHh004812@repo.freebsd.org>
next in thread | previous in thread | raw e-mail | index | archive | help
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. Bruce
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20170316144923.O1839>