Documentation: note styling for bit fields

Our codebase uses a lot of bit field variables, generally to mark boolean type variables. While there is a formatting rule in the '.clang-format', there is no guideline specified in the 'CodingGuidelines'. Since the '.clang-format' is not yet enforced, let's also add a guideline with the same rule as mentioned in the '.clang-format', which is to not use any spaces around the colon, like so: unsigned my_field:1; unsigned other_field:1; unsigned field_with_longer_name:1; This would allow us not to modify the clang-format file, and more importantly, discourage people from doing ugly alignment with spaces, i.e. unsigned my_field : 1; unsigned other_field : 1; unsigned field_with_longer_name : 1; Helped-by: Junio C Hamano <gitster@pobox.com> Signed-off-by: Karthik Nayak <karthik.188@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Karthik Nayak committed Aug 26, 2025 at 14:19 UTC 929b1d08f790938e147301a61c2dee4253cc3fa5
1 file changed +6
Documentation/CodingGuidelines
+6
@@ -650,6 +650,12 @@ For C programs:
650 cases. However, it is recommended to find a more descriptive name wherever
651 possible to improve the readability and maintainability of the code.
652
653 + - Bit fields should be defined without a space around the colon. E.g.
654 +
655 + unsigned my_field:1;
656 + unsigned other_field:1;
657 + unsigned field_with_longer_name:1;
658 +
659 For Perl programs:
660
661 - Most of the C guidelines above apply.