* [PATCH -next] HID: intel-ish-hid: ishtp-fw-loader: Fix a kernel-doc formatting issue
@ 2021-12-16 4:01 Yang Li
2021-12-16 4:08 ` Randy Dunlap
2022-01-06 13:20 ` Jiri Kosina
0 siblings, 2 replies; 3+ messages in thread
From: Yang Li @ 2021-12-16 4:01 UTC (permalink / raw)
To: srinivas.pandruvada
Cc: jikos, benjamin.tissoires, linux-input, linux-kernel, Yang Li,
Abaci Robot
This function had kernel-doc that not used a hash to separate
the function name from the one line description.
The warning was found by running scripts/kernel-doc, which is
caused by using 'make W=1'.
drivers/hid/intel-ish-hid/ishtp-fw-loader.c:271: warning: This comment
starts with '/**', but isn't a kernel-doc comment. Refer
Documentation/doc-guide/kernel-doc.rst
Reported-by: Abaci Robot <abaci@linux.alibaba.com>
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
drivers/hid/intel-ish-hid/ishtp-fw-loader.c | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/drivers/hid/intel-ish-hid/ishtp-fw-loader.c b/drivers/hid/intel-ish-hid/ishtp-fw-loader.c
index 0e1183e96147..e24988586710 100644
--- a/drivers/hid/intel-ish-hid/ishtp-fw-loader.c
+++ b/drivers/hid/intel-ish-hid/ishtp-fw-loader.c
@@ -268,7 +268,8 @@ static int get_firmware_variant(struct ishtp_cl_data *client_data,
}
/**
- * loader_cl_send() Send message from host to firmware
+ * loader_cl_send() - Send message from host to firmware
+ *
* @client_data: Client data instance
* @out_msg: Message buffer to be sent to firmware
* @out_size: Size of out going message
--
2.20.1.7.g153144c
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH -next] HID: intel-ish-hid: ishtp-fw-loader: Fix a kernel-doc formatting issue
2021-12-16 4:01 [PATCH -next] HID: intel-ish-hid: ishtp-fw-loader: Fix a kernel-doc formatting issue Yang Li
@ 2021-12-16 4:08 ` Randy Dunlap
2022-01-06 13:20 ` Jiri Kosina
1 sibling, 0 replies; 3+ messages in thread
From: Randy Dunlap @ 2021-12-16 4:08 UTC (permalink / raw)
To: Yang Li, srinivas.pandruvada
Cc: jikos, benjamin.tissoires, linux-input, linux-kernel, Abaci Robot
Hi,
On 12/15/21 20:01, Yang Li wrote:
> This function had kernel-doc that not used a hash to separate
that did not use a dash or hyphen to separate
Patch looks good. Thanks.
> the function name from the one line description.
>
> The warning was found by running scripts/kernel-doc, which is
> caused by using 'make W=1'.
>
> drivers/hid/intel-ish-hid/ishtp-fw-loader.c:271: warning: This comment
> starts with '/**', but isn't a kernel-doc comment. Refer
> Documentation/doc-guide/kernel-doc.rst
>
> Reported-by: Abaci Robot <abaci@linux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
> ---
> drivers/hid/intel-ish-hid/ishtp-fw-loader.c | 3 ++-
> 1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/drivers/hid/intel-ish-hid/ishtp-fw-loader.c b/drivers/hid/intel-ish-hid/ishtp-fw-loader.c
> index 0e1183e96147..e24988586710 100644
> --- a/drivers/hid/intel-ish-hid/ishtp-fw-loader.c
> +++ b/drivers/hid/intel-ish-hid/ishtp-fw-loader.c
> @@ -268,7 +268,8 @@ static int get_firmware_variant(struct ishtp_cl_data *client_data,
> }
>
> /**
> - * loader_cl_send() Send message from host to firmware
> + * loader_cl_send() - Send message from host to firmware
> + *
> * @client_data: Client data instance
> * @out_msg: Message buffer to be sent to firmware
> * @out_size: Size of out going message
>
--
~Randy
^ permalink raw reply [flat|nested] 3+ messages in thread* Re: [PATCH -next] HID: intel-ish-hid: ishtp-fw-loader: Fix a kernel-doc formatting issue
2021-12-16 4:01 [PATCH -next] HID: intel-ish-hid: ishtp-fw-loader: Fix a kernel-doc formatting issue Yang Li
2021-12-16 4:08 ` Randy Dunlap
@ 2022-01-06 13:20 ` Jiri Kosina
1 sibling, 0 replies; 3+ messages in thread
From: Jiri Kosina @ 2022-01-06 13:20 UTC (permalink / raw)
To: Yang Li
Cc: srinivas.pandruvada, benjamin.tissoires, linux-input,
linux-kernel, Abaci Robot
On Thu, 16 Dec 2021, Yang Li wrote:
> This function had kernel-doc that not used a hash to separate
> the function name from the one line description.
>
> The warning was found by running scripts/kernel-doc, which is
> caused by using 'make W=1'.
>
> drivers/hid/intel-ish-hid/ishtp-fw-loader.c:271: warning: This comment
> starts with '/**', but isn't a kernel-doc comment. Refer
> Documentation/doc-guide/kernel-doc.rst
>
> Reported-by: Abaci Robot <abaci@linux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
Applied, thanks.
--
Jiri Kosina
SUSE Labs
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2022-01-06 13:21 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2021-12-16 4:01 [PATCH -next] HID: intel-ish-hid: ishtp-fw-loader: Fix a kernel-doc formatting issue Yang Li
2021-12-16 4:08 ` Randy Dunlap
2022-01-06 13:20 ` Jiri Kosina
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox