Date: Thu, 21 Jun 2018 09:20:33 +0100 From: Edward Tomasz Napierala <trasz@freebsd.org> To: Ian Lepore <ian@freebsd.org> Cc: Konstantin Belousov <kostikbel@gmail.com>, src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org Subject: Re: svn commit: r335456 - head/share/man/man7 Message-ID: <20180621082033.GA1820@brick> In-Reply-To: <1529525332.24573.13.camel@freebsd.org> References: <201806201916.w5KJGpFg048232@repo.freebsd.org> <20180620195407.GS2430@kib.kiev.ua> <1529525332.24573.13.camel@freebsd.org>
next in thread | previous in thread | raw e-mail | index | archive | help
On 0620T1408, Ian Lepore wrote: > On Wed, 2018-06-20 at 22:54 +0300, Konstantin Belousov wrote: > > On Wed, Jun 20, 2018 at 07:16:51PM +0000, Edward Tomasz Napierala wrote: > > > > > > Author: trasz > > > Date: Wed Jun 20 19:16:51 2018 > > > New Revision: 335456 > > > URL: https://svnweb.freebsd.org/changeset/base/335456 > > > > > > Log: > > > Improve wording. > > > > > > MFC after: 2 weeks > > > > > > Modified: > > > head/share/man/man7/development.7 > > > > > > Modified: head/share/man/man7/development.7 > > > ============================================================================== > > > --- head/share/man/man7/development.7 Wed Jun 20 18:51:38 2018 (r335455) > > > +++ head/share/man/man7/development.7 Wed Jun 20 19:16:51 2018 (r335456) > > > @@ -24,7 +24,7 @@ > > > .\" > > > .\" $FreeBSD$ > > > .\" > > > -.Dd May 11, 2018 > > > +.Dd June 20, 2018 > > > .Dt DEVELOPMENT 7 > > > .Os > > > .Sh NAME > > > @@ -81,7 +81,7 @@ Build instructions can be found in > > > .Xr build 7 > > > and > > > .Xr release 7 . > > > -Kernel APIs are usually documented, use > > > +Kernel APIs are documented in section 9 manual pages; use > > Kernel API is an oxymoron. Section 9 describes Kernel Programming > > Interfaces, the A from Application is not needed. We usually abbreviate > > it as KPI. > > This is the manpage a new developer is going to look at, and if you > throw an abbreviation like KPI at them and they search for what it > means, they're going to find "Key Performance Indicator" and nothing > about kernels. This might be a good place to introduce and define that > acronym, maybe something like "Kernel programming interfaces (KPIs) are > documented...". Thank you both, fixed.
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20180621082033.GA1820>