Skip to contentSkip to conversation

xen: Fix one kernel-doc comment

PATCH Applied Yang Li 2 participants 3 messages Jul 31, 2023 – Aug 22, 2023 Xen hypervisor interface

lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH 1/1 xen: Fix one kernel-doc comment

Use colon to separate parameter name from their specific meaning. silence the warning:

drivers/xen/grant-table.c:1051: warning: Function parameter or member 'nr_pages' not described in 'gnttab_free_pages'

---
 drivers/xen/grant-table.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/xen/grant-table.c +1 -1
index f13c3b76ad1e..35659bf70746 100644
@@ -1044,7 +1044,7 @@ EXPORT_SYMBOL_GPL(gnttab_pages_clear_private);
 
 /**
  * gnttab_free_pages - free pages allocated by gnttab_alloc_pages()
- * @nr_pages; number of pages to free
+ * @nr_pages: number of pages to free
  * @pages: the pages
  */
 void gnttab_free_pages(int nr_pages, struct page **pages)
Signature · 1 line
2.20.1.7.g153144c
maintainer Acked-by on v1 1/1
#1 lore raw
Quoted 8 lines · Yang Li

Use colon to separate parameter name from their specific meaning. silence the warning:

drivers/xen/grant-table.c:1051: warning: Function parameter or member 'nr_pages' not described in 'gnttab_free_pages'

Juergen

maintainer Applied
#2 lore raw
In reply to Yang Li
Quoted 8 lines · Yang Li

Use colon to separate parameter name from their specific meaning. silence the warning:

drivers/xen/grant-table.c:1051: warning: Function parameter or member 'nr_pages' not described in 'gnttab_free_pages'

Pushed to xen/tip.git for-linus-6.6

Juergen