[PATCH v2 0/2] clang-format: format short enums and macro definitions correctly

[PATCH v2 0/2] clang-format: format short enums and macro definitions correctly

[Michael Riesch via B4 Relay]

Habidere,

These patches set two previously unset clang-format options to
(hopefully) sane values.

Looking forward to your comments!

Best regards,
Michael

Signed-off-by: Michael Riesch <michael.riesch@wolfvision.net>
Signed-off-by: Michael Riesch <michael.riesch@collabora.com>
---
Changes in v2:
- collected Nathan's Reviewed-by
- rebased onto v6.15-rc1
- Link to v1: https://lore.kernel.org/r/20250210-clang-format-fixes-v1-0-9bcf43a4b4b2@wolfvision.net

---
Michael Riesch (2):
      clang-format: do not allow short enums on a single line
      clang-format: align consecutive macros

 .clang-format | 2 ++
 1 file changed, 2 insertions(+)
---
base-commit: 0af2f6be1b4281385b618cb86ad946eded089ac8
change-id: 20250210-clang-format-fixes-914ded0e682d

Best regards,
-- 
Michael Riesch <michael.riesch@collabora.com>

[PATCH v2 1/2] clang-format: do not allow short enums on a single line

[Michael Riesch via B4 Relay]

From: Michael Riesch <michael.riesch@wolfvision.net>

clang-format 11 introduced the option "AllowShortEnumsOnASingleLine".
Set it to "false" in order to avoid short enums of the form:

    enum my_short_num { green, red };

With the option set to "false", they will be converted to

    enum my_short_num {
            green,
            red
    };

which is consistent with the definition of enums with more items.

Signed-off-by: Michael Riesch <michael.riesch@wolfvision.net>
Reviewed-by: Nathan Chancellor <nathan@kernel.org>
Signed-off-by: Michael Riesch <michael.riesch@collabora.com>
---
 .clang-format | 1 +
 1 file changed, 1 insertion(+)

diff --git a/.clang-format b/.clang-format
index fe1aa1a30d40..8040b516185b 100644
--- a/.clang-format
+++ b/.clang-format
@@ -19,6 +19,7 @@ AlignTrailingComments: false
 AllowAllParametersOfDeclarationOnNextLine: false
 AllowShortBlocksOnASingleLine: false
 AllowShortCaseLabelsOnASingleLine: false
+AllowShortEnumsOnASingleLine: false
 AllowShortFunctionsOnASingleLine: None
 AllowShortIfStatementsOnASingleLine: false
 AllowShortLoopsOnASingleLine: false

-- 
2.39.5

[PATCH v2 2/2] clang-format: align consecutive macros

[Michael Riesch via B4 Relay]

From: Michael Riesch <michael.riesch@wolfvision.net>

clang-format 9 introduced the option "AlignConsecutiveMacros".
Set it to "AcrossEmptyLinesAndComments" in order to avoid macro
definitions of the form:

    #define MAGIC_REGISTER_1 0x42
    #define MAGIC_REGISTER_BIT_FLIP BIT(2)
    /* important comment */
    #define MAGIC_REGISTER_BIT_ENABLE BIT(12)

    #define MAGIC_REGISTER_2 0x43

With the option set to "AcrossEmptyLinesAndComments", they will
be converted to

    #define MAGIC_REGISTER_1	      0x42
    #define MAGIC_REGISTER_BIT_FLIP   BIT(2)
    /* important comment */
    #define MAGIC_REGISTER_BIT_ENABLE BIT(12)

    #define MAGIC_REGISTER_2	      0x43

which seems to be the convention in the kernel code base.

Signed-off-by: Michael Riesch <michael.riesch@wolfvision.net>
Reviewed-by: Nathan Chancellor <nathan@kernel.org>
Signed-off-by: Michael Riesch <michael.riesch@collabora.com>
---
 .clang-format | 1 +
 1 file changed, 1 insertion(+)

diff --git a/.clang-format b/.clang-format
index 8040b516185b..30d09cb88170 100644
--- a/.clang-format
+++ b/.clang-format
@@ -13,6 +13,7 @@ AccessModifierOffset: -4
 AlignAfterOpenBracket: Align
 AlignConsecutiveAssignments: false
 AlignConsecutiveDeclarations: false
+AlignConsecutiveMacros: AcrossEmptyLinesAndComments
 AlignEscapedNewlines: Left
 AlignOperands: true
 AlignTrailingComments: false

-- 
2.39.5

Re: [PATCH v2 0/2] clang-format: format short enums and macro definitions correctly

[Michael Riesch]

Hi all,

On 4/10/25 22:58, Michael Riesch via B4 Relay wrote:
> Habidere,
> 
> These patches set two previously unset clang-format options to
> (hopefully) sane values.
> 
> Looking forward to your comments!
> 
> Best regards,
> Michael
> 
> Signed-off-by: Michael Riesch <michael.riesch@wolfvision.net>
> Signed-off-by: Michael Riesch <michael.riesch@collabora.com>
> ---
> Changes in v2:
> - collected Nathan's Reviewed-by
> - rebased onto v6.15-rc1
> - Link to v1: https://lore.kernel.org/r/20250210-clang-format-fixes-v1-0-9bcf43a4b4b2@wolfvision.net
> 
> ---
> Michael Riesch (2):
>       clang-format: do not allow short enums on a single line
>       clang-format: align consecutive macros
> 
>  .clang-format | 2 ++
>  1 file changed, 2 insertions(+)
> ---
> base-commit: 0af2f6be1b4281385b618cb86ad946eded089ac8
> change-id: 20250210-clang-format-fixes-914ded0e682d
> 
> Best regards,

Gentle ping.

Can these patches be applied?

Thanks and best regards,
Michael