From owner-svn-src-all@freebsd.org  Tue Sep 20 04:50:55 2016
Return-Path: <owner-svn-src-all@freebsd.org>
Delivered-To: svn-src-all@mailman.ysv.freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org
 [IPv6:2001:1900:2254:206a::19:1])
 by mailman.ysv.freebsd.org (Postfix) with ESMTP id 18397BE017B;
 Tue, 20 Sep 2016 04:50:55 +0000 (UTC) (envelope-from imp@FreeBSD.org)
Received: from repo.freebsd.org (repo.freebsd.org
 [IPv6:2610:1c1:1:6068::e6a:0])
 (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
 (Client did not present a certificate)
 by mx1.freebsd.org (Postfix) with ESMTPS id DF8591464;
 Tue, 20 Sep 2016 04:50:54 +0000 (UTC) (envelope-from imp@FreeBSD.org)
Received: from repo.freebsd.org ([127.0.1.37])
 by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id u8K4osuG021494;
 Tue, 20 Sep 2016 04:50:54 GMT (envelope-from imp@FreeBSD.org)
Received: (from imp@localhost)
 by repo.freebsd.org (8.15.2/8.15.2/Submit) id u8K4osHX021493;
 Tue, 20 Sep 2016 04:50:54 GMT (envelope-from imp@FreeBSD.org)
Message-Id: <201609200450.u8K4osHX021493@repo.freebsd.org>
X-Authentication-Warning: repo.freebsd.org: imp set sender to imp@FreeBSD.org
 using -f
From: Warner Losh <imp@FreeBSD.org>
Date: Tue, 20 Sep 2016 04:50:54 +0000 (UTC)
To: src-committers@freebsd.org, svn-src-all@freebsd.org,
 svn-src-head@freebsd.org
Subject: svn commit: r306010 - head/share/man/man9
X-SVN-Group: head
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
X-BeenThere: svn-src-all@freebsd.org
X-Mailman-Version: 2.1.23
Precedence: list
List-Id: "SVN commit messages for the entire src tree \(except for &quot;
 user&quot; and &quot; projects&quot; \)" <svn-src-all.freebsd.org>
List-Unsubscribe: <https://lists.freebsd.org/mailman/options/svn-src-all>,
 <mailto:svn-src-all-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/svn-src-all/>
List-Post: <mailto:svn-src-all@freebsd.org>
List-Help: <mailto:svn-src-all-request@freebsd.org?subject=help>
List-Subscribe: <https://lists.freebsd.org/mailman/listinfo/svn-src-all>,
 <mailto:svn-src-all-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Tue, 20 Sep 2016 04:50:55 -0000

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.