diff mbox series

list.h: fix list_is_first() kernel-doc

Message ID ddce8b80-9a8a-d52d-3546-87b2211c089a@infradead.org (mailing list archive)
State New, archived
Headers show
Series list.h: fix list_is_first() kernel-doc | expand

Commit Message

Randy Dunlap March 18, 2019, 12:16 a.m. UTC 
From: Randy Dunlap <rdunlap@infradead.org>

Fix typo of kernel-doc parameter notation (there should be
no space between '@' and the parameter name).

Also fixes bogus kernel-doc notation output formatting.

Fixes: 70b44595eafe9 ("mm, compaction: use free lists to quickly locate a migration source")

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Mel Gorman <mgorman@techsingularity.net>
---
 include/linux/list.h |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Mel Gorman March 19, 2019, 10:04 a.m. UTC | #1 
On Sun, Mar 17, 2019 at 05:16:26PM -0700, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@infradead.org>
> 
> Fix typo of kernel-doc parameter notation (there should be
> no space between '@' and the parameter name).
> 
> Also fixes bogus kernel-doc notation output formatting.
> 
> Fixes: 70b44595eafe9 ("mm, compaction: use free lists to quickly locate a migration source")
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Mel Gorman <mgorman@techsingularity.net>

Thanks

Acked-by: Mel Gorman <mgorman@techsingularity.net>
William Kucharski March 20, 2019, 1:08 p.m. UTC | #2 
> On Mar 17, 2019, at 6:16 PM, Randy Dunlap <rdunlap@infradead.org> wrote:
> 
> From: Randy Dunlap <rdunlap@infradead.org>
> 
> Fix typo of kernel-doc parameter notation (there should be
> no space between '@' and the parameter name).
> 
> Also fixes bogus kernel-doc notation output formatting.
> 
> Fixes: 70b44595eafe9 ("mm, compaction: use free lists to quickly locate a migration source")
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Mel Gorman <mgorman@techsingularity.net>
> ---

Nice little cleanup.

Reviewed-by: William Kucharski <william.kucharski@oracle.com>
diff mbox series

Patch

--- lnx-51-rc1.orig/include/linux/list.h
+++ lnx-51-rc1/include/linux/list.h
@@ -207,7 +207,7 @@  static inline void list_bulk_move_tail(s
 }
 
 /**
- * list_is_first -- tests whether @ list is the first entry in list @head
+ * list_is_first -- tests whether @list is the first entry in list @head
  * @list: the entry to test
  * @head: the head of the list
  */