]> git.ipfire.org Git - thirdparty/git.git/commitdiff
Documentation: clarify indentation style for C preprocessor directives
authorPatrick Steinhardt <ps@pks.im>
Tue, 30 Jul 2024 07:24:38 +0000 (09:24 +0200)
committerJunio C Hamano <gitster@pobox.com>
Tue, 30 Jul 2024 20:50:25 +0000 (13:50 -0700)
In the preceding commit, we have settled on using a single space per
nesting level to indent preprocessor directives. Clarify our coding
guidelines accordingly.

Signed-off-by: Patrick Steinhardt <ps@pks.im>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/CodingGuidelines

index 1d92b2da03e8ca4f6f562ed55e2a6d9199b592c3..65fba3b810069cfabf07067d2e654b913b7a082a 100644 (file)
@@ -214,6 +214,16 @@ For C programs:
  - We use tabs to indent, and interpret tabs as taking up to
    8 spaces.
 
+ - Nested C preprocessor directives are indented after the hash by one
+   space per nesting level.
+
+       #if FOO
+       # include <foo.h>
+       # if BAR
+       #  include <bar.h>
+       # endif
+       #endif
+
  - We try to keep to at most 80 characters per line.
 
  - As a Git developer we assume you have a reasonably modern compiler