RFC: Add clang-format and kerneldoc check
Get series with b4
b4 am [email protected]Versions newest first
- v1 Latest10 patches 13 repliesIn review
Patches in v1 No applies recorded yet
| # | Subject and files | Size | Replies | Applied |
|---|---|---|---|---|
| 1/10 | make: add target to check kernel-doc commentsMakefile scripts/ | +2529 | 1 reply | |
| 2/10 | powerpc: properly format non-kernel-doc commentspowerpc/ powerpc/ powerpc/ | +6 | 5 replies | |
| 3/10 | lib: s390x: cpacf: move kernel-doc comment to correct functionlib/ | +10 | 1 reply | |
| 4/10 | s390x: properly format non-kernel-doc commentss390x/ | +16 | 2 replies | |
| 5/10 | s390x: ensure kernel-doc parameters are properly formatedlib/ | +3 | 1 reply | |
| 6/10 | x86: properly format non-kernel-doc commentsx86/ | +1 | 1 reply | |
| 7/10 | s390x: cpumodel: list tcg_fail explicitlys390x/ | +19 | 0 replies | |
| 8/10 | s390x: gs: turn off formatter for inline assemblys390x/ | +23 | 0 replies | |
| 9/10 | add clang-format configuration file.clang-format | +689 | 1 reply | |
| 10/10 | add make formatMakefile | +3 | 0 replies |
Reviews trailers per patch
6 of 10 patches have a Reviewed-by or Acked-by.
| Patch | Thomas Huth |
|---|---|
| 1/10 | R-b |
| 2/10 | R-b |
| 3/10 | R-b |
| 4/10 | R-b |
| 5/10 | R-b |
| 6/10 | R-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.
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