Skip site navigation (1)Skip section navigation (2)
Date:      Mon, 19 Sep 2016 21:53:35 -0700
From:      Conrad Meyer <cem@freebsd.org>
To:        Warner Losh <imp@freebsd.org>
Cc:        src-committers <src-committers@freebsd.org>, svn-src-all@freebsd.org,  svn-src-head@freebsd.org
Subject:   Re: svn commit: r306010 - head/share/man/man9
Message-ID:  <CAG6CVpXfBLfDG1VvMV1hja71ncjG_a4zQSZpyDuDKuUbLiKCxA@mail.gmail.com>
In-Reply-To: <201609200450.u8K4osHX021493@repo.freebsd.org>
References:  <201609200450.u8K4osHX021493@repo.freebsd.org>

next in thread | previous in thread | raw e-mail | index | archive | help
Thanks!

On Mon, Sep 19, 2016 at 9:50 PM, Warner Losh <imp@freebsd.org> wrote:
> Author: imp
> Date: Tue Sep 20 04:50:53 2016
> New Revision: 306010
> URL: https://svnweb.freebsd.org/changeset/base/306010
>
> Log:
>   Document existing practice and be more clear about sys/foo.h files
>   being alphabetical with sys/param.h or sys/types.h being first. Expand
>   the example to hopefully make this (slightly) clearer.
>
>   Noticed by: cem@
>
> Modified:
>   head/share/man/man9/style.9
>
> Modified: head/share/man/man9/style.9
> ==============================================================================
> --- head/share/man/man9/style.9 Tue Sep 20 04:33:58 2016        (r306009)
> +++ head/share/man/man9/style.9 Tue Sep 20 04:50:53 2016        (r306010)
> @@ -118,17 +118,21 @@ Leave another blank line before the head
>  .Pp
>  Kernel include files (i.e.\&
>  .Pa sys/*.h )
> -come first; normally, include
> +come first sorted alphebetially where possible.
> +Include
>  .In sys/types.h
>  OR
>  .In sys/param.h ,
> -but not both.
> +but not both and include it first.
>  .In sys/types.h
>  includes
>  .In sys/cdefs.h ,
>  and it is okay to depend on that.
>  .Bd -literal
>  #include <sys/types.h> /* Non-local includes in angle brackets. */
> +#include <sys/endian.h>
> +#include <sys/lock.h>
> +#include <sys/queue.h>
>  .Ed
>  .Pp
>  For a network program, put the network include files next.
>



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?CAG6CVpXfBLfDG1VvMV1hja71ncjG_a4zQSZpyDuDKuUbLiKCxA>