From: Bagas Sanjaya <bagasdotme@gmail.com>
To: linux-doc@vger.kernel.org
Cc: "Bagas Sanjaya" <bagasdotme@gmail.com>,
"Nikolai Kondrashov" <spbnick@gmail.com>,
"Jiri Kosina" <jikos@kernel.org>,
"Benjamin Tissoires" <benjamin.tissoires@redhat.com>,
"José Expósito" <jose.exposito89@gmail.com>,
llvm@lists.linux.dev, linux-input@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: [PATCH 0/2] HID: uclogic: kernel-doc fixes for uclogic_params_* functions
Date: Sat, 28 May 2022 16:14:01 +0700 [thread overview]
Message-ID: <20220528091403.160169-1-bagasdotme@gmail.com> (raw)
Running kernel-doc script on drivers/hid/hid-uclogic-params.c found
these 6 warnings below:
drivers/hid/hid-uclogic-params.c:48: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* Dump tablet interface pen parameters with hid_dbg(), indented with one tab.
drivers/hid/hid-uclogic-params.c:48: warning: missing initial short description on line:
* Dump tablet interface pen parameters with hid_dbg(), indented with one tab.
drivers/hid/hid-uclogic-params.c:48: info: Scanning doc for function Dump
drivers/hid/hid-uclogic-params.c:80: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* Dump tablet interface frame parameters with hid_dbg(), indented with two
drivers/hid/hid-uclogic-params.c:80: warning: missing initial short description on line:
* Dump tablet interface frame parameters with hid_dbg(), indented with two
drivers/hid/hid-uclogic-params.c:80: info: Scanning doc for function Dump
drivers/hid/hid-uclogic-params.c:105: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* Dump tablet interface parameters with hid_dbg().
drivers/hid/hid-uclogic-params.c:105: warning: missing initial short description on line:
* Dump tablet interface parameters with hid_dbg().
One of them is reported by kernel test robot at kernel test robot at
[1].
[1]: https://lore.kernel.org/linux-doc/202205272033.XFYlYj8k-lkp@intel.com/
Fix these warnings by remove extraneous asterisk on static function
comments on patch [1/2] and add missing function name for void function
on patch [2/2].
Cc: Nikolai Kondrashov <spbnick@gmail.com>
Cc: Jiri Kosina <jikos@kernel.org>
Cc: Benjamin Tissoires <benjamin.tissoires@redhat.com>
Cc: "José Expósito" <jose.exposito89@gmail.com>
Cc: llvm@lists.linux.dev
Cc: linux-input@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Bagas Sanjaya (2):
HID: uclogic: remove extraneous asterisk on uclogic_params_* static
functions comments
HID: uclogic: add missing function name in uclogic_params_hid_dbg()
kernel-doc comment
drivers/hid/hid-uclogic-params.c | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
base-commit: bf272460d744112bacd4c4d562592decbf0edf64
--
An old man doll... just what I always wanted! - Clara
next reply other threads:[~2022-05-28 9:14 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-05-28 9:14 Bagas Sanjaya [this message]
2022-05-28 9:14 ` [PATCH 1/2] HID: uclogic: remove extraneous asterisk on uclogic_params_* static functions comments Bagas Sanjaya
2022-05-29 15:02 ` Jonathan Corbet
2022-05-28 9:14 ` [PATCH 2/2] HID: uclogic: add missing function name in uclogic_params_hid_dbg() kernel-doc comment Bagas Sanjaya
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=20220528091403.160169-1-bagasdotme@gmail.com \
--to=bagasdotme@gmail.com \
--cc=benjamin.tissoires@redhat.com \
--cc=jikos@kernel.org \
--cc=jose.exposito89@gmail.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-input@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=llvm@lists.linux.dev \
--cc=spbnick@gmail.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.