From owner-svn-src-all@freebsd.org Thu Mar 16 04:05:32 2017 Return-Path: Delivered-To: svn-src-all@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 5EA61D0E96E; Thu, 16 Mar 2017 04:05:32 +0000 (UTC) (envelope-from yaneurabeya@gmail.com) Received: from mail-pg0-x242.google.com (mail-pg0-x242.google.com [IPv6:2607:f8b0:400e:c05::242]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (Client CN "smtp.gmail.com", Issuer "Google Internet Authority G2" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 2B8721257; Thu, 16 Mar 2017 04:05:32 +0000 (UTC) (envelope-from yaneurabeya@gmail.com) Received: by mail-pg0-x242.google.com with SMTP id g2so4463959pge.2; Wed, 15 Mar 2017 21:05:32 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=subject:mime-version:from:in-reply-to:date:cc:message-id:references :to; bh=nv7D8r7G8qcLxOLVCp5mE4Fl4+a9fZ42leAzbSJHauU=; b=lUM0R0lbbdlWZH2WW7cRG4yXRs6ntkUKmA0o/dNnnHwUrmLOsk4YPSzfV1vgQZP11V zAZMKHr+BnvFNrSx1Wexs2KgnMriy+YryPggE5urOwRP1++kFwg+Tip0xgSEOSDMv1GU tM4uH41XltlW8VeXM8ZwKMtdQX0TSceIJTxB7bO/u9r1QJcpb0eDgN/N0Us+jaMAtrLE BhPdhLxyO/ERIGet/FYKJOl0dbBACXXTt2F3Y/4J23WYNb3qIJ6FBXlwsx+C9Mt7mBIQ lkrls1fndNOEWGG+4FvK9ZQa0fdT0PNfpnFy3rKROQnHAvTHPnFX9E/kkI7lDcvdykl6 9cjA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:subject:mime-version:from:in-reply-to:date:cc :message-id:references:to; bh=nv7D8r7G8qcLxOLVCp5mE4Fl4+a9fZ42leAzbSJHauU=; b=jFMlhjAFdkdHw9sF83HI2WVUUkAB16zWq5mV1VKFMuOA/NCrh3hRDyAq+pt9vy7ML/ AgB0PSFA5B2BPYFKz7KNU1RZP4y+/59Fd0faP/nsBdkEZ7yAqBF6KsW21Ec8AtnnJU1Z WMWoruwnaqhcSPZdT5jRvHrbaqI0twyuJMlAYTLkTS945Qp2y07OCcacmMXCnpVX7KPa BVztHF6r1U0zo/IVK6KTuiAua14d+V7VVbbLqV3rGINENq9LYIJoZCkntMCrjg09aKEK zN+33wCdfKwHHwLwRR7Jg2/E68S5CRlUnGupc1O8jkiLIdcxsYFPtSeSFoWlOjxuen0/ NqWg== X-Gm-Message-State: AFeK/H2H1MljLjEw4teySfRYhFshoiV/ViA4ZIydiFUOq6yl4o/Zz1znktXXwTniCrIOhQ== X-Received: by 10.84.209.204 with SMTP id y70mr9373230plh.69.1489637131671; Wed, 15 Mar 2017 21:05:31 -0700 (PDT) Received: from pinklady.local (c-73-19-52-228.hsd1.wa.comcast.net. [73.19.52.228]) by smtp.gmail.com with ESMTPSA id d1sm6914408pfk.20.2017.03.15.21.05.30 (version=TLS1 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 15 Mar 2017 21:05:30 -0700 (PDT) Subject: Re: svn commit: r315365 - head/lib/libkvm Mime-Version: 1.0 (Mac OS X Mail 9.3 \(3124\)) Content-Type: multipart/signed; boundary="Apple-Mail=_8268C623-C698-4F1C-A905-56CA46F188DB"; protocol="application/pgp-signature"; micalg=pgp-sha512 X-Pgp-Agent: GPGMail From: "Ngie Cooper (yaneurabeya)" In-Reply-To: <20170316144923.O1839@besplex.bde.org> Date: Wed, 15 Mar 2017 21:05:29 -0700 Cc: Ngie Cooper , src-committers , svn-src-all@freebsd.org, svn-src-head@freebsd.org Message-Id: References: <201703160324.v2G3OFHh004812@repo.freebsd.org> <20170316144923.O1839@besplex.bde.org> To: Bruce Evans X-Mailer: Apple Mail (2.3124) X-BeenThere: svn-src-all@freebsd.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "SVN commit messages for the entire src tree \(except for " user" and " projects" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 16 Mar 2017 04:05:32 -0000 --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 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--