Git Has a Variable Named false_but_the_compiler_does_not_know_it

3 hours ago

Git uses a variable named false_but_the_compiler_does_not_know_it_ to prevent Clang from flagging valid code as unreachable due to the -Wunreachable-code warning.
The variable is defined as a global integer initialized to 0 in a separate compilation unit, making the compiler unable to prove it remains 0 during compilation.
It is used in the NOT_CONSTANT macro, which performs a logical OR with an expression to make the compiler treat the expression as non-constant, avoiding false positives.
This trick is applied in Git's code, such as in refs/files-backend.c, to maintain consistent control flow across different build configurations (e.g., when NO_SYMLINK_HEAD is defined).
Without the macro, Clang might warn about unreachable code (like a continue statement) when functions are compiled away as constants, though the code remains reachable in other builds.
The macro was added to manage warnings without disabling -Wunreachable-code entirely, providing an escape hatch for false positives while preserving useful warnings.
Alternative solutions include using conditional preprocessor directives, compiler-specific pragmas, or volatile variables, but Git's approach is precise and reusable without introducing extra overhead.
Link-time optimization (LTO) can remove the branch at link time since it sees the variable's definition and lack of modification, but the trick still prevents warnings during normal compilation.

Hasty Briefsbeta