Date: Tue, 20 Sep 2016 04:50:54 +0000 (UTC) From: Warner Losh <imp@FreeBSD.org> To: src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org Subject: svn commit: r306010 - head/share/man/man9 Message-ID: <201609200450.u8K4osHX021493@repo.freebsd.org>
next in thread | raw e-mail | index | archive | help
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?201609200450.u8K4osHX021493>