Date: Fri, 31 Jul 2015 00:03:14 -0700 From: John-Mark Gurney <jmg@funkthat.com> To: Bruce Evans <brde@optusnet.com.au> Cc: src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org Subject: Re: svn commit: r286103 - head/share/man/man9 Message-ID: <20150731070314.GY78154@funkthat.com> In-Reply-To: <20150731152253.Y1843@besplex.bde.org> References: <201507310328.t6V3S3LC087650@repo.freebsd.org> <20150731152253.Y1843@besplex.bde.org>
next in thread | previous in thread | raw e-mail | index | archive | help
Bruce Evans wrote this message on Fri, Jul 31, 2015 at 16:21 +1000:
> On Fri, 31 Jul 2015, John-Mark Gurney wrote:
>
> > Log:
> > The implementation note isn't true anymore..
> >
> > Not that anyone reads it, but those that do, remind them that this
> > isn't usable in userland... I can't wait till this doc is wrong..
>
> It goes without saying that an API documented in a section 9 man page
> isn't usable in userland
I think you mean that some API's are well documented in section 9
and undocumented in section 3. For example, atomic(9) is used in
userland in such places as libthr, jemalloc, and more.
> In this case, it is obviously even more unusable in userland, because
> the documentation specifies including <sys/systm.h>. That header is
> undocumented, but everyone should know that it it is kernel-only.
Well, now I know.. it'd be nice to document it w/ an
ifndef _KERNEL/error line.. or at least a comment... or even in
the documentation...
[...]
--
John-Mark Gurney Voice: +1 415 225 5579
"All that I will do, has been done, All that I have, has not."
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20150731070314.GY78154>