commit 9f34110a08cde80c65b3002e8108d1bff93d309a
author Patrick Venture <venture@google.com> Tue Aug 28 10:29:34 2018 -0700
committer Patrick Venture <venture@google.com> Wed Aug 29 09:20:12 2018 -0700
tree df8b0faa7a2642fe526ce86de61f8bee2beb4d1d
parent 873a0495132085bb661389c25f1917f4c6cb4b5c

add header ordering section to style guide

Adds a section to the style guide defining a header inclusion order for
header files and source files.

Change-Id: Ieb723380bbab257b98b319cda999cf0e9c1ef389
Signed-off-by: Patrick Venture <venture@google.com>

cpp-style-and-conventions.md

diff --git a/cpp-style-and-conventions.md b/cpp-style-and-conventions.md
index e550a39..d270c5a 100644
--- a/cpp-style-and-conventions.md
+++ b/cpp-style-and-conventions.md
@@ -159,7 +159,7 @@
 directory of the repository, and will check that there are no files that were
 modified after running it (same check as running clang).
 
-OpenBMC requires a clang-format of version 5.0 or greater. An example of
+OpenBMC requires a clang-format of version 6.0 or greater. An example of
 how to run clang-format against all code in your repo can be found by
 referencing the [tool](https://github.com/openbmc/openbmc-build-scripts/blob/master/scripts/format-code.sh) used by CI.
 
@@ -215,6 +215,20 @@
 ExperimentalAutoDetectBinPacking: false
 FixNamespaceComments: true
 ForEachMacros:   [ foreach, Q_FOREACH, BOOST_FOREACH ]
+IncludeBlocks: Regroup
+IncludeCategories:
+  - Regex:           '^[<"](gtest|gmock)'
+    Priority:        5
+  - Regex:           '^"config.h"'
+    Priority:        -1
+  - Regex:           '^".*\.hpp"'
+    Priority:        1
+  - Regex:           '^<.*\.h>'
+    Priority:        2
+  - Regex:           '^<.*'
+    Priority:        3
+  - Regex:           '.*'
+    Priority:        4
 IndentCaseLabels: true
 IndentWidth:     4
 IndentWrappedFunctionNames: true
@@ -234,7 +248,7 @@
 PenaltyReturnTypeOnItsOwnLine: 60
 PointerAlignment: Right
 ReflowComments:  true
-SortIncludes:    false
+SortIncludes:    true
 SpaceAfterCStyleCast: false
 SpaceBeforeAssignmentOperators: true
 SpaceBeforeParens: ControlStatements
@@ -381,6 +395,25 @@
 SomeBmcType someBmcVariable = BMCFunction();
 ```
 
+### Header Ordering
+
+Header inclusion order for a header file:
+```
+local headers (e.g. "daemon_sys.hpp")
+c-libraries
+cpp-libraries (including openbmc libraries)
+```
+
+Header inclusion order for a source file:
+```
+source.hpp (if applicable)
+local headers
+c-libraries
+cpp-libraries
+```
+
+All in alphabetically sorted order.
+
 #### Files
 
 * C++ headers should end in ".hpp".  C headers should end in ".h".