From: Patrick Steinhardt Date: Tue, 31 Mar 2026 23:57:46 GMT Subject: [PATCH 1/6] CodingGuidelines: document our style for flags Message-ID: <20260401-pks-odb-cleanups-v1-1-89adba9ada68@pks.im> In-Reply-To: <20260401-pks-odb-cleanups-v1-0-89adba9ada68@pks.im> We have recently iterated a bit on our style for flags. Document this. Signed-off-by: Patrick Steinhardt --- Documentation/CodingGuidelines | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index b8670751f5..4992e52093 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -668,6 +668,18 @@ For C programs: unsigned other_field:1; unsigned field_with_longer_name:1; + - When a function `F` accepts flags, those flags should be defined as `enum + F_flags`. Individual flag definitions should start with `F` and be in + all-uppercase letters. Flag values should be represented via bit shifts. + E.g. + + enum frobnicate_flags { + FROBNICATE_FOO = (1 << 0), + FROBNICATE_BAR = (1 << 1), + }; + + int frobnicate(enum frobnicate_flags flags); + - Array names should be named in the singular form if the individual items are subject of use. E.g.: -- 2.53.0.1185.g05d4b7b318.dirty