Skip to content

Commit fcae987

Browse files
committed
Merge branch 'jc/coding-guidelines'
* jc/coding-guidelines: CodingGuidelines: clarify C #include rules
2 parents 14f5630 + 412cb2e commit fcae987

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

Documentation/CodingGuidelines

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -328,9 +328,14 @@ For C programs:
328328

329329
- When you come up with an API, document it.
330330

331-
- The first #include in C files, except in platform specific
332-
compat/ implementations, should be git-compat-util.h or another
333-
header file that includes it, such as cache.h or builtin.h.
331+
- The first #include in C files, except in platform specific compat/
332+
implementations, must be either "git-compat-util.h", "cache.h" or
333+
"builtin.h". You do not have to include more than one of these.
334+
335+
- A C file must directly include the header files that declare the
336+
functions and the types it uses, except for the functions and types
337+
that are made available to it by including one of the header files
338+
it must include by the previous rule.
334339

335340
- If you are planning a new command, consider writing it in shell
336341
or perl first, so that changes in semantics can be easily

0 commit comments

Comments
 (0)