public inbox for kvm@vger.kernel.org
 help / color / mirror / Atom feed
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 05/10] s390x: ensure kernel-doc parameters are properly formated
Date: Mon,  6 Nov 2023 13:51:01 +0100	[thread overview]
Message-ID: <20231106125352.859992-6-nrb@linux.ibm.com> (raw)
In-Reply-To: <20231106125352.859992-1-nrb@linux.ibm.com>

In kernel-doc, parameters names should end in a colon (:). Add them
where they are missing.

Signed-off-by: Nico Boehr <nrb@linux.ibm.com>
---
 lib/s390x/interrupt.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/lib/s390x/interrupt.c b/lib/s390x/interrupt.c
index 3f993a363ae2..75edcbfecb7d 100644
--- a/lib/s390x/interrupt.c
+++ b/lib/s390x/interrupt.c
@@ -61,7 +61,7 @@ uint16_t clear_pgm_int(void)
 
 /**
  * check_pgm_int_code - Check the program interrupt code on the current CPU.
- * @code the expected program interrupt code on the current CPU
+ * @code: the expected program interrupt code on the current CPU
  *
  * Check and report if the program interrupt on the current CPU matches the
  * expected one.
@@ -77,7 +77,7 @@ void check_pgm_int_code(uint16_t code)
 /**
  * register_pgm_cleanup_func - Register a cleanup function for progam
  * interrupts for the current CPU.
- * @f the cleanup function to be registered on the current CPU
+ * @f: the cleanup function to be registered on the current CPU
  *
  * Register a cleanup function to be called at the end of the normal
  * interrupt handling for program interrupts for this CPU.
@@ -92,7 +92,7 @@ void register_pgm_cleanup_func(void (*f)(struct stack_frame_int *))
 /**
  * register_ext_cleanup_func - Register a cleanup function for external
  * interrupts for the current CPU.
- * @f the cleanup function to be registered on the current CPU
+ * @f: the cleanup function to be registered on the current CPU
  *
  * Register a cleanup function to be called at the end of the normal
  * interrupt handling for external interrupts for this CPU.
-- 
2.41.0


  parent 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 [kvm-unit-tests PATCH v1 00/10] RFC: Add clang-format and kerneldoc check Nico Boehr
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 ` Nico Boehr [this message]
2023-11-22 12:49   ` [kvm-unit-tests PATCH v1 05/10] s390x: ensure kernel-doc parameters are properly formated 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-6-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