undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'jc/coding-guidelines'

Browse Source 
* jc/coding-guidelines:
  CodingGuidelines: clarify C #include rules
This commit is contained in:
Junio C Hamano 2015-02-11 13:37:42 -08:00
commit fcae987e94
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Documentation/CodingGuidelines
View File

@ -328,9 +328,14 @@ For C programs:
- When you come up with an API, document it. - When you come up with an API, document it.
- The first #include in C files, except in platform specific - The first #include in C files, except in platform specific compat/
compat/ implementations, should be git-compat-util.h or another implementations, must be either "git-compat-util.h", "cache.h" or
header file that includes it, such as cache.h or builtin.h. "builtin.h". You do not have to include more than one of these.
- A C file must directly include the header files that declare the
functions and the types it uses, except for the functions and types
that are made available to it by including one of the header files
it must include by the previous rule.
- If you are planning a new command, consider writing it in shell - If you are planning a new command, consider writing it in shell
or perl first, so that changes in semantics can be easily or perl first, so that changes in semantics can be easily