]> git.ipfire.org Git - thirdparty/git.git/commit
Documentation: note styling for bit fields
authorKarthik Nayak <karthik.188@gmail.com>
Tue, 26 Aug 2025 12:19:28 +0000 (14:19 +0200)
committerJunio C Hamano <gitster@pobox.com>
Tue, 26 Aug 2025 22:46:03 +0000 (15:46 -0700)
commit929b1d08f790938e147301a61c2dee4253cc3fa5
tree3390cca36785cd129e49250e82bea707d4705319
parentc44beea485f0f2feaf460e2ac87fdd5608d63cf0
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>
Documentation/CodingGuidelines