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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]


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

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


[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Index of Archives]     [Kernel Development]     [Kernel Newbies]     [IDE]     [Security]     [Git]     [Netfilter]     [Bugtraq]     [Yosemite Info]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux ATA RAID]     [Samba]     [Linux Media]     [Device Mapper]

  Powered by Linux