Date: Fri, 31 Jul 2015 11:22:14 -0700 From: John-Mark Gurney <jmg@funkthat.com> To: Warner Losh <imp@bsdimp.com> Cc: Ed Schouten <ed@nuxi.nl>, src-committers <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: <20150731182214.GD78154@funkthat.com> In-Reply-To: <9E180F45-B3B1-46C0-B02A-FFC3EB667A82@bsdimp.com> References: <201507310328.t6V3S3LC087650@repo.freebsd.org> <CABh_MKm45daZPYPNFBmmkdP32sNMCtu1w33kapcouPvxcfN8_Q@mail.gmail.com> <20150731163110.GZ78154@funkthat.com> <9E180F45-B3B1-46C0-B02A-FFC3EB667A82@bsdimp.com>
next in thread | previous in thread | raw e-mail | index | archive | help
Warner Losh wrote this message on Fri, Jul 31, 2015 at 10:37 -0600:
>
> > On Jul 31, 2015, at 10:31 AM, John-Mark Gurney <jmg@funkthat.com> wrote:
> >
> > Ed Schouten wrote this message on Fri, Jul 31, 2015 at 11:24 +0200:
> >> Maybe it would make more sense to just remove this manual page?
> >>
> >> It looks like there are already some pieces of code in our source tree
> >> that use _Static_assert(), which is good. Maybe it would be better to
> >> to leave CTASSERT() undocumented, so that it becomes less likely that
> >> new code uses this interface.
> >
> > I plan on documenting _Static_assert, and once that is documented
> > for both userland and kernel, then we can mark this deprecated???
>
> We generally don???t document built-in language features. Just add a note
> to the CTASSERT man page that says use it instead.
Ok, will do...
This adds another question, since _Static_assert is a C11 feature, we
should probably document that we provide compatibility for non-C11
compilers for this via sys/cdefs.h, correct? Though then for gcc
and other pre-C11, _Static_assert isn't a built-in language feature..
Should we simplify the cdefs.h ifdef crazyness by assuming that anyone
w/ __STDC_VERSION__ == 201112 has it?
> > Do we support linking man pages between man3/man9? or should it just
> > be in a comment? and in one section?
>
> Put them in section 9 with a note saying they work for user land. There???s maybe
> a dozen that apply to both. We???ve historically not tried to share them.
Thanks.
--
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?20150731182214.GD78154>