diff mbox series

tools: usbip: list.h: fix kernel-doc for list_del()

Message ID 20210324000223.22043-1-rdunlap@infradead.org (mailing list archive)
State Superseded
Headers show
Series tools: usbip: list.h: fix kernel-doc for list_del() | expand

Commit Message

Randy Dunlap March 24, 2021, 12:02 a.m. UTC
In list.h, the kernel-doc for list_del() should be immediately
preceding the implementation and not separated from it by
another function implementation.

Eliminates this kernel-doc error:
list.h:1: warning: 'list_del' not found

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Valentina Manea <valentina.manea.m@gmail.com>
Cc: Shuah Khan <shuah@kernel.org>
Cc: Shuah Khan <skhan@linuxfoundation.org>
Cc: linux-usb@vger.kernel.org
---
 tools/usb/usbip/libsrc/list.h |   10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

Comments

Shuah Khan March 24, 2021, 11:32 p.m. UTC | #1
On 3/23/21 6:02 PM, Randy Dunlap wrote:
> In list.h, the kernel-doc for list_del() should be immediately
> preceding the implementation and not separated from it by
> another function implementation.
> 
> Eliminates this kernel-doc error:
> list.h:1: warning: 'list_del' not found
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Valentina Manea <valentina.manea.m@gmail.com>
> Cc: Shuah Khan <shuah@kernel.org>
> Cc: Shuah Khan <skhan@linuxfoundation.org>
> Cc: linux-usb@vger.kernel.org
> ---
>   tools/usb/usbip/libsrc/list.h |   10 +++++-----
>   1 file changed, 5 insertions(+), 5 deletions(-)
> 
> --- linux-next-20210323.orig/tools/usb/usbip/libsrc/list.h
> +++ linux-next-20210323/tools/usb/usbip/libsrc/list.h
> @@ -77,17 +77,17 @@ static inline void __list_del(struct lis
>   #define LIST_POISON1  ((void *) 0x00100100 + POISON_POINTER_DELTA)
>   #define LIST_POISON2  ((void *) 0x00200200 + POISON_POINTER_DELTA)
>   
> +static inline void __list_del_entry(struct list_head *entry)
> +{
> +	__list_del(entry->prev, entry->next);
> +}
> +
>   /**
>    * list_del - deletes entry from list.
>    * @entry: the element to delete from the list.
>    * Note: list_empty() on entry does not return true after this, the entry is
>    * in an undefined state.
>    */
> -static inline void __list_del_entry(struct list_head *entry)
> -{
> -	__list_del(entry->prev, entry->next);
> -}
> -
>   static inline void list_del(struct list_head *entry)
>   {
>   	__list_del(entry->prev, entry->next);
> 

Thank you for fixing this.

Acked-by: Shuah Khan <skhan@linuxfoundation.org>

thanks,
-- Shuah
Randy Dunlap March 25, 2021, 1:35 a.m. UTC | #2
On 3/24/21 4:32 PM, Shuah Khan wrote:
> On 3/23/21 6:02 PM, Randy Dunlap wrote:
>> In list.h, the kernel-doc for list_del() should be immediately
>> preceding the implementation and not separated from it by
>> another function implementation.
>>
>> Eliminates this kernel-doc error:
>> list.h:1: warning: 'list_del' not found
>>
>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>> Cc: Valentina Manea <valentina.manea.m@gmail.com>
>> Cc: Shuah Khan <shuah@kernel.org>
>> Cc: Shuah Khan <skhan@linuxfoundation.org>
>> Cc: linux-usb@vger.kernel.org
>> ---
>>   tools/usb/usbip/libsrc/list.h |   10 +++++-----
>>   1 file changed, 5 insertions(+), 5 deletions(-)
>>
>> --- linux-next-20210323.orig/tools/usb/usbip/libsrc/list.h
>> +++ linux-next-20210323/tools/usb/usbip/libsrc/list.h
>> @@ -77,17 +77,17 @@ static inline void __list_del(struct lis
>>   #define LIST_POISON1  ((void *) 0x00100100 + POISON_POINTER_DELTA)
>>   #define LIST_POISON2  ((void *) 0x00200200 + POISON_POINTER_DELTA)
>>   +static inline void __list_del_entry(struct list_head *entry)
>> +{
>> +    __list_del(entry->prev, entry->next);
>> +}
>> +
>>   /**
>>    * list_del - deletes entry from list.
>>    * @entry: the element to delete from the list.
>>    * Note: list_empty() on entry does not return true after this, the entry is
>>    * in an undefined state.
>>    */
>> -static inline void __list_del_entry(struct list_head *entry)
>> -{
>> -    __list_del(entry->prev, entry->next);
>> -}
>> -
>>   static inline void list_del(struct list_head *entry)
>>   {
>>       __list_del(entry->prev, entry->next);
>>
> 
> Thank you for fixing this.
> 
> Acked-by: Shuah Khan <skhan@linuxfoundation.org>


Thanks. Who do you think should merge this patch?
Greg KH March 25, 2021, 6:40 a.m. UTC | #3
On Wed, Mar 24, 2021 at 06:35:01PM -0700, Randy Dunlap wrote:
> On 3/24/21 4:32 PM, Shuah Khan wrote:
> > On 3/23/21 6:02 PM, Randy Dunlap wrote:
> >> In list.h, the kernel-doc for list_del() should be immediately
> >> preceding the implementation and not separated from it by
> >> another function implementation.
> >>
> >> Eliminates this kernel-doc error:
> >> list.h:1: warning: 'list_del' not found
> >>
> >> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> >> Cc: Valentina Manea <valentina.manea.m@gmail.com>
> >> Cc: Shuah Khan <shuah@kernel.org>
> >> Cc: Shuah Khan <skhan@linuxfoundation.org>
> >> Cc: linux-usb@vger.kernel.org
> >> ---
> >>   tools/usb/usbip/libsrc/list.h |   10 +++++-----
> >>   1 file changed, 5 insertions(+), 5 deletions(-)
> >>
> >> --- linux-next-20210323.orig/tools/usb/usbip/libsrc/list.h
> >> +++ linux-next-20210323/tools/usb/usbip/libsrc/list.h
> >> @@ -77,17 +77,17 @@ static inline void __list_del(struct lis
> >>   #define LIST_POISON1  ((void *) 0x00100100 + POISON_POINTER_DELTA)
> >>   #define LIST_POISON2  ((void *) 0x00200200 + POISON_POINTER_DELTA)
> >>   +static inline void __list_del_entry(struct list_head *entry)
> >> +{
> >> +    __list_del(entry->prev, entry->next);
> >> +}
> >> +
> >>   /**
> >>    * list_del - deletes entry from list.
> >>    * @entry: the element to delete from the list.
> >>    * Note: list_empty() on entry does not return true after this, the entry is
> >>    * in an undefined state.
> >>    */
> >> -static inline void __list_del_entry(struct list_head *entry)
> >> -{
> >> -    __list_del(entry->prev, entry->next);
> >> -}
> >> -
> >>   static inline void list_del(struct list_head *entry)
> >>   {
> >>       __list_del(entry->prev, entry->next);
> >>
> > 
> > Thank you for fixing this.
> > 
> > Acked-by: Shuah Khan <skhan@linuxfoundation.org>
> 
> 
> Thanks. Who do you think should merge this patch?

I can :)
diff mbox series

Patch

--- linux-next-20210323.orig/tools/usb/usbip/libsrc/list.h
+++ linux-next-20210323/tools/usb/usbip/libsrc/list.h
@@ -77,17 +77,17 @@  static inline void __list_del(struct lis
 #define LIST_POISON1  ((void *) 0x00100100 + POISON_POINTER_DELTA)
 #define LIST_POISON2  ((void *) 0x00200200 + POISON_POINTER_DELTA)
 
+static inline void __list_del_entry(struct list_head *entry)
+{
+	__list_del(entry->prev, entry->next);
+}
+
 /**
  * list_del - deletes entry from list.
  * @entry: the element to delete from the list.
  * Note: list_empty() on entry does not return true after this, the entry is
  * in an undefined state.
  */
-static inline void __list_del_entry(struct list_head *entry)
-{
-	__list_del(entry->prev, entry->next);
-}
-
 static inline void list_del(struct list_head *entry)
 {
 	__list_del(entry->prev, entry->next);