Date: Wed, 15 Mar 2017 21:05:29 -0700 From: "Ngie Cooper (yaneurabeya)" <yaneurabeya@gmail.com> To: Bruce Evans <brde@optusnet.com.au> Cc: Ngie Cooper <ngie@freebsd.org>, src-committers <src-committers@freebsd.org>, svn-src-all@freebsd.org, svn-src-head@freebsd.org Subject: Re: svn commit: r315365 - head/lib/libkvm Message-ID: <A917B5FC-3373-4CC8-86D6-ACFA2D5C8A44@gmail.com> In-Reply-To: <20170316144923.O1839@besplex.bde.org> References: <201703160324.v2G3OFHh004812@repo.freebsd.org> <20170316144923.O1839@besplex.bde.org>
next in thread | previous in thread | raw e-mail | index | archive | help
--Apple-Mail=_8268C623-C698-4F1C-A905-56CA46F188DB Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset=us-ascii > On Mar 15, 2017, at 21:00, Bruce Evans <brde@optusnet.com.au> wrote: >=20 > On Thu, 16 Mar 2017, Ngie Cooper wrote: >=20 >> Log: >> Tweak r315363 slightly >>=20 >> 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. >=20 > 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. >=20 > 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. >=20 > 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 --Apple-Mail=_8268C623-C698-4F1C-A905-56CA46F188DB Content-Transfer-Encoding: 7bit Content-Disposition: attachment; filename=signature.asc Content-Type: application/pgp-signature; name=signature.asc Content-Description: Message signed with OpenPGP using GPGMail -----BEGIN PGP SIGNATURE----- Comment: GPGTools - https://gpgtools.org iQIcBAEBCgAGBQJYyg8JAAoJEPWDqSZpMIYVXtcP/RxMbYOrCAbjm7E7uOeczBCV IbxyRfKx+quBdXAtQK+JfTpScLOV2Wd6vw6qMYrf1tqlHjYWbYWPeIRS8zMg6nmU FG9PjdVfYPmDLHQFrZwUZCWiKdSROWmxO5Z+ygbXu/qiW6pXhZFDQaYPyswSn37f 8y86ia7mt+jX44dks3jomllLyZ5GApsxIWykyHEa0hjm4F7MIbP8OOA4QwpZ++UO fVr164YMt+GEXc+58RRhvQoL8kBTOV6gsXK65hhumSkuKLNQfC5QyDGbyfNXOIu8 SjflUkzZjnzgKpAKqWmkC5uLOoLk6of3iHc02KEdoRwLA3VcxFbyeCIt20PZ8Zwb v7LVuBwKsWoPY+pDN3485d8bK8YgdoS13yo/Da4aFP3s1gA2E9b5jrOSuoM2MIBH ld8ZgpC1J3SH5DBBNDYFozcYmO4wzBVTWFAM7Em2MH7P5M/rrxNZvon8cNmvTplz z6NyE9KsZmJuis1MTdp576WHAG+K5924rYvaWeqrlW8fCurWJZAljpf6tb2/9zRv HjuS6+s5b30IUlH/z0SVHLcWQ9lS85L0pdLfaOMNL44fF2dPDiLr7BOvU5XUohxe QM5UQ4U8nk65mLrNV7I0Ze+VcFG/94ELZQgH7Tlcvcsu6zcc4yWka6THNopzEnAd dL0NqcUNPW9oY24yZxll =UTGn -----END PGP SIGNATURE----- --Apple-Mail=_8268C623-C698-4F1C-A905-56CA46F188DB--
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?A917B5FC-3373-4CC8-86D6-ACFA2D5C8A44>