]> git.ipfire.org Git - thirdparty/git.git/commitdiff
CodingGuidelines: spaces around C operators
authorJunio C Hamano <gitster@pobox.com>
Tue, 20 Aug 2024 20:36:11 +0000 (13:36 -0700)
committerJunio C Hamano <gitster@pobox.com>
Tue, 20 Aug 2024 21:10:10 +0000 (14:10 -0700)
As we have operated with "write like how your surrounding code is
written" for too long, after a huge code drop from another project,
we'll end up being inconsistent before such an imported code is
cleaned up.  We have many uses of cast operator with a space before
its operand, mostly in the reftable code.

Spell the convention out before it spreads to other places.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/CodingGuidelines

index 52afb2725f240dac4007e78d2408bec54395f138..4e6edf3d66c44d725eb47be9c9e6c4ef0c0ee0d7 100644 (file)
@@ -293,7 +293,9 @@ For C programs:
      v12.01, 2022-03-28).
 
  - Variables have to be declared at the beginning of the block, before
-   the first statement (i.e. -Wdeclaration-after-statement).
+   the first statement (i.e. -Wdeclaration-after-statement).  It is
+   encouraged to have a blank line between the end of the declarations
+   and the first statement in the block.
 
  - NULL pointers shall be written as NULL, not as 0.
 
@@ -313,6 +315,13 @@ For C programs:
         while( condition )
                func (bar+1);
 
+ - A binary operator (other than ",") and ternary conditional "?:"
+   have a space on each side of the operator to separate it from its
+   operands.  E.g. "A + 1", not "A+1".
+
+ - A unary operator (other than "." and "->") have no space between it
+   and its operand.  E.g. "(char *)ptr", not "(char *) ptr".
+
  - Do not explicitly compare an integral value with constant 0 or '\0',
    or a pointer value with constant NULL.  For instance, to validate that
    counted array <ptr, cnt> is initialized but has no elements, write: