From: Nico Boehr <nrb@linux.ibm.com>
To: frankja@linux.ibm.com, imbrenda@linux.ibm.com, thuth@redhat.com,
david@redhat.com, pbonzini@redhat.com, andrew.jones@linux.dev,
lvivier@redhat.com
Cc: kvm@vger.kernel.org, linux-s390@vger.kernel.org
Subject: [kvm-unit-tests PATCH v1 00/10] RFC: Add clang-format and kerneldoc check
Date: Mon, 6 Nov 2023 13:50:56 +0100 [thread overview]
Message-ID: <20231106125352.859992-1-nrb@linux.ibm.com> (raw)
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
--
2.41.0
next reply other threads:[~2023-11-06 12:54 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-11-06 12:50 Nico Boehr [this message]
2023-11-06 12:50 ` [kvm-unit-tests PATCH v1 01/10] make: add target to check kernel-doc comments Nico Boehr
2023-11-22 12:27 ` Thomas Huth
2023-11-06 12:50 ` [kvm-unit-tests PATCH v1 02/10] powerpc: properly format non-kernel-doc comments Nico Boehr
2023-11-06 16:53 ` Claudio Imbrenda
2023-11-06 17:13 ` Nico Boehr
2023-11-07 8:37 ` Thomas Huth
2023-11-07 18:42 ` Claudio Imbrenda
2023-11-22 12:28 ` Thomas Huth
2023-11-06 12:50 ` [kvm-unit-tests PATCH v1 03/10] lib: s390x: cpacf: move kernel-doc comment to correct function Nico Boehr
2023-11-22 12:47 ` Thomas Huth
2023-11-06 12:51 ` [kvm-unit-tests PATCH v1 04/10] s390x: properly format non-kernel-doc comments Nico Boehr
2023-11-06 16:54 ` Claudio Imbrenda
2023-11-22 12:47 ` Thomas Huth
2023-11-06 12:51 ` [kvm-unit-tests PATCH v1 05/10] s390x: ensure kernel-doc parameters are properly formated Nico Boehr
2023-11-22 12:49 ` Thomas Huth
2023-11-06 12:51 ` [kvm-unit-tests PATCH v1 06/10] x86: properly format non-kernel-doc comments Nico Boehr
2023-11-22 12:49 ` Thomas Huth
2023-11-06 12:51 ` [kvm-unit-tests PATCH v1 07/10] s390x: cpumodel: list tcg_fail explicitly Nico Boehr
2023-11-06 12:51 ` [kvm-unit-tests PATCH v1 08/10] s390x: gs: turn off formatter for inline assembly Nico Boehr
2023-11-06 12:51 ` [kvm-unit-tests PATCH v1 09/10] add clang-format configuration file Nico Boehr
2023-11-22 12:56 ` Thomas Huth
2023-11-06 12:51 ` [kvm-unit-tests PATCH v1 10/10] add make format Nico Boehr
2023-11-22 13:09 ` [kvm-unit-tests PATCH v1 00/10] RFC: Add clang-format and kerneldoc check Thomas Huth
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20231106125352.859992-1-nrb@linux.ibm.com \
--to=nrb@linux.ibm.com \
--cc=andrew.jones@linux.dev \
--cc=david@redhat.com \
--cc=frankja@linux.ibm.com \
--cc=imbrenda@linux.ibm.com \
--cc=kvm@vger.kernel.org \
--cc=linux-s390@vger.kernel.org \
--cc=lvivier@redhat.com \
--cc=pbonzini@redhat.com \
--cc=thuth@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox