Skip to content

RFC: Add clang-format and kerneldoc check

Nico Boehr kvm linux-s390 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest10 patches 13 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/10make: add target to check kernel-doc commentsMakefile scripts/kernel-doc+2529 -01 reply
2/10powerpc: properly format non-kernel-doc commentspowerpc/emulator.c powerpc/spapr_hcall.c powerpc/spapr_vpa.c+6 -65 replies
3/10lib: s390x: cpacf: move kernel-doc comment to correct functionlib/s390x/asm/cpacf.h+10 -101 reply
4/10s390x: properly format non-kernel-doc commentss390x/sclp.c+16 -162 replies
5/10s390x: ensure kernel-doc parameters are properly formatedlib/s390x/interrupt.c+3 -31 reply
6/10x86: properly format non-kernel-doc commentsx86/msr.c+1 -11 reply
7/10s390x: cpumodel: list tcg_fail explicitlys390x/cpumodel.c+19 -190 replies
8/10s390x: gs: turn off formatter for inline assemblys390x/gs.c+23 -210 replies
9/10add clang-format configuration file.clang-format+689 -01 reply
10/10add make formatMakefile+3 -00 replies

Reviews trailers per patch

6 of 10 patches have a Reviewed-by or Acked-by.

PatchThomas Huth
1/10R-b
2/10R-b
3/10R-b
4/10R-b
5/10R-b
6/10R-b
7/10
8/10
9/10
10/10

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v1 thread

Cover letter [kvm-unit-tests PATCH v1 00/10] RFC: Add clang-format and kerneldoc check

It is important that we have a consistent formatting of our source code and comments in kvm-unit-tests.

Yet, it's not always easy since tiny formatting mistakes are hard to spot for reviewers. Respinning patches because of these issues can also be frustrating for contributors.

This series is a RFC suggestion on how the situation could be improved for kvm-unit-tests.

It adds a clang-format file, mostly based on the one already present in the kernel. A new "make format" target makes it easy to properly format the source. If maintainers want, they could even re-format the source code of ther arch to ensure a consistent code formatting, but this is entirely optional. I am also happy to move the "make format" into arch-specific code if requested.

Additionally, I noticed that there is quite inconsistent use of kernel-doc comments in the code. Add a respective check command and fix the existing issues.

Nico Boehr (10):
make: add target to check kernel-doc comments
powerpc: properly format non-kernel-doc comments
lib: s390x: cpacf: move kernel-doc comment to correct function
s390x: properly format non-kernel-doc comments
s390x: ensure kernel-doc parameters are properly formated
x86: properly format non-kernel-doc comments
s390x: cpumodel: list tcg_fail explicitly
s390x: gs: turn off formatter for inline assembly add clang-format configuration file
add make format

 .clang-format         |  689 +++++++++++
 Makefile              |    6 +
 lib/s390x/asm/cpacf.h |   20 +-
 lib/s390x/interrupt.c |    6 +-
 powerpc/emulator.c    |    2 +-
 powerpc/spapr_hcall.c |    6 +-
 powerpc/spapr_vpa.c   |    4 +-
 s390x/cpumodel.c      |   38 +-
 s390x/gs.c            |   44 +-
 s390x/sclp.c          |   32 +-
 scripts/kernel-doc    | 2526 +++++++++++++++++++++++++++++++++++++++++
 x86/msr.c             |    2 +-
 12 files changed, 3299 insertions(+), 76 deletions(-)
 create mode 100644 .clang-format
 create mode 100755 scripts/kernel-doc
Signature · 1 line
2.41.0