[PATCH v2] HSI: cmt_speech: unmark comments as kernel-doc

[PATCH v2] HSI: cmt_speech: unmark comments as kernel-doc

[Randy Dunlap]

Fix build warnings from the kernel test robot:

drivers/hsi/clients/cmt_speech.c:831: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Block until pending data transfers have completed.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reported-by: kernel test robot <lkp@intel.com>
Cc: Sebastian Reichel <sre@kernel.org>
Cc: Aditya Srivastava <yashsri421@gmail.com>
Acked-by: Pavel Machek <pavel@ucw.cz>
---
v2: Drop #Cc: Kai Vehmanen <kai.vehmanen@nokia.com> [bounce]
    Add Pavel's Ack.

 drivers/hsi/clients/cmt_speech.c |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

--- linux-next-20210928.orig/drivers/hsi/clients/cmt_speech.c
+++ linux-next-20210928/drivers/hsi/clients/cmt_speech.c
@@ -827,7 +827,7 @@ static int check_buf_params(struct cs_hs
 	return r;
 }
 
-/**
+/*
  * Block until pending data transfers have completed.
  */
 static int cs_hsi_data_sync(struct cs_hsi_iface *hi)
@@ -850,7 +850,7 @@ static int cs_hsi_data_sync(struct cs_hs
 			r = -ERESTARTSYS;
 			goto out;
 		}
-		/**
+		/*
 		 * prepare_to_wait must be called with hi->lock held
 		 * so that callbacks can check for waitqueue_active()
 		 */

Re: [PATCH v2] HSI: cmt_speech: unmark comments as kernel-doc

[Pavel Machek]

[-- Attachment #1: Type: text/plain, Size: 712 bytes --]

Hi!

> Fix build warnings from the kernel test robot:
> 
> drivers/hsi/clients/cmt_speech.c:831: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>     * Block until pending data transfers have completed.
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Reported-by: kernel test robot <lkp@intel.com>
> Cc: Sebastian Reichel <sre@kernel.org>
> Cc: Aditya Srivastava <yashsri421@gmail.com>
> Acked-by: Pavel Machek <pavel@ucw.cz>

If noone applies it, you may want to send it to akpm, he's  often
helpful in pushing similar patches.

Best regards,
							Pavel
							
-- 
http://www.livejournal.com/~pavelmachek

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 195 bytes --]

Re: [PATCH v2] HSI: cmt_speech: unmark comments as kernel-doc

[Randy Dunlap]

On 9/28/21 11:57 AM, Pavel Machek wrote:
> Hi!
> 
>> Fix build warnings from the kernel test robot:
>>
>> drivers/hsi/clients/cmt_speech.c:831: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>>      * Block until pending data transfers have completed.
>>
>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>> Reported-by: kernel test robot <lkp@intel.com>
>> Cc: Sebastian Reichel <sre@kernel.org>
>> Cc: Aditya Srivastava <yashsri421@gmail.com>
>> Acked-by: Pavel Machek <pavel@ucw.cz>
> 
> If noone applies it, you may want to send it to akpm, he's  often
> helpful in pushing similar patches.

Yes, good idea. Thanks.

-- 
~Randy

Re: [PATCH v2] HSI: cmt_speech: unmark comments as kernel-doc

[Sebastian Reichel]

[-- Attachment #1: Type: text/plain, Size: 1075 bytes --]

Hi,

On Tue, Sep 28, 2021 at 12:52:03PM -0700, Randy Dunlap wrote:
> On 9/28/21 11:57 AM, Pavel Machek wrote:
> > Hi!
> > 
> > > Fix build warnings from the kernel test robot:
> > > 
> > > drivers/hsi/clients/cmt_speech.c:831: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> > >      * Block until pending data transfers have completed.
> > > 
> > > Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> > > Reported-by: kernel test robot <lkp@intel.com>
> > > Cc: Sebastian Reichel <sre@kernel.org>
> > > Cc: Aditya Srivastava <yashsri421@gmail.com>
> > > Acked-by: Pavel Machek <pavel@ucw.cz>
> > 
> > If noone applies it, you may want to send it to akpm, he's  often
> > helpful in pushing similar patches.
> 
> Yes, good idea. Thanks.

Looks like I missed v1. The patch LGTM and I can apply it to the hsi tree.
If you already sent it to akpm, that's also fine. Not much is happening in
HSI nowadays and it probably will be the only patch for the next cycle.

-- Sebastian

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH v2] HSI: cmt_speech: unmark comments as kernel-doc

[Randy Dunlap]

On 9/30/21 10:01 AM, Sebastian Reichel wrote:
> Hi,
> 
> On Tue, Sep 28, 2021 at 12:52:03PM -0700, Randy Dunlap wrote:
>> On 9/28/21 11:57 AM, Pavel Machek wrote:
>>> Hi!
>>>
>>>> Fix build warnings from the kernel test robot:
>>>>
>>>> drivers/hsi/clients/cmt_speech.c:831: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>>>>       * Block until pending data transfers have completed.
>>>>
>>>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>>>> Reported-by: kernel test robot <lkp@intel.com>
>>>> Cc: Sebastian Reichel <sre@kernel.org>
>>>> Cc: Aditya Srivastava <yashsri421@gmail.com>
>>>> Acked-by: Pavel Machek <pavel@ucw.cz>
>>>
>>> If noone applies it, you may want to send it to akpm, he's  often
>>> helpful in pushing similar patches.
>>
>> Yes, good idea. Thanks.
> 
> Looks like I missed v1. The patch LGTM and I can apply it to the hsi tree.
> If you already sent it to akpm, that's also fine. Not much is happening in
> HSI nowadays and it probably will be the only patch for the next cycle.

You go ahead with it, please.

thanks.
-- 
~Randy