| Message ID | 20211216040146.89075-1-yang.lee@linux.alibaba.com (mailing list archive) |
|---|---|
| State | Mainlined |
| Commit | 98b6b62cd5569a158868b62dc7866b5aae5d9a38 |
| Delegated to: | Jiri Kosina |
| Headers | show |
| Series | [-next] HID: intel-ish-hid: ishtp-fw-loader: Fix a kernel-doc formatting issue | expand |
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 >
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.
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
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(-)