[PATCH -next] mm: page_alloc: fix kernel-doc warning

[PATCH -next] mm: page_alloc: fix kernel-doc warning

[Randy Dunlap]

From: Randy Dunlap <rdunlap@infradead.org>

Add description of function parameter 'mt' to fix kernel-doc warning:

../mm/page_alloc.c:3246: warning: Function parameter or member 'mt' not described in '__putback_isolated_page'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
 mm/page_alloc.c |    1 +
 1 file changed, 1 insertion(+)

--- linux-next-20200407.orig/mm/page_alloc.c
+++ linux-next-20200407/mm/page_alloc.c
@@ -3238,6 +3238,7 @@ int __isolate_free_page(struct page *pag
  * __putback_isolated_page - Return a now-isolated page back where we got it
  * @page: Page that was isolated
  * @order: Order of the isolated page
+ * @mt: The page's pageblock's migratetype
  *
  * This function is meant to return a page pulled from the free lists via
  * __isolate_free_page back to the free lists they were pulled from.

Re: [PATCH -next] mm: page_alloc: fix kernel-doc warning

[Alexander Duyck]

On Tue, Apr 7, 2020 at 9:30 PM Randy Dunlap <rdunlap@infradead.org> wrote:
>
> From: Randy Dunlap <rdunlap@infradead.org>
>
> Add description of function parameter 'mt' to fix kernel-doc warning:
>
> ../mm/page_alloc.c:3246: warning: Function parameter or member 'mt' not described in '__putback_isolated_page'
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

Thanks for catching this. The fix looks good to me.

Acked-by: Alexander Duyck <alexander.h.duyck@linux.intel.com>

> ---
>  mm/page_alloc.c |    1 +
>  1 file changed, 1 insertion(+)
>
> --- linux-next-20200407.orig/mm/page_alloc.c
> +++ linux-next-20200407/mm/page_alloc.c
> @@ -3238,6 +3238,7 @@ int __isolate_free_page(struct page *pag
>   * __putback_isolated_page - Return a now-isolated page back where we got it
>   * @page: Page that was isolated
>   * @order: Order of the isolated page
> + * @mt: The page's pageblock's migratetype
>   *
>   * This function is meant to return a page pulled from the free lists via
>   * __isolate_free_page back to the free lists they were pulled from.
>
>

Re: [PATCH -next] mm: page_alloc: fix kernel-doc warning

[Pankaj Gupta]

> Add description of function parameter 'mt' to fix kernel-doc warning:
>
> ../mm/page_alloc.c:3246: warning: Function parameter or member 'mt' not described in '__putback_isolated_page'
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
>  mm/page_alloc.c |    1 +
>  1 file changed, 1 insertion(+)
>
> --- linux-next-20200407.orig/mm/page_alloc.c
> +++ linux-next-20200407/mm/page_alloc.c
> @@ -3238,6 +3238,7 @@ int __isolate_free_page(struct page *pag
>   * __putback_isolated_page - Return a now-isolated page back where we got it
>   * @page: Page that was isolated
>   * @order: Order of the isolated page
> + * @mt: The page's pageblock's migratetype
>   *
>   * This function is meant to return a page pulled from the free lists via
>   * __isolate_free_page back to the free lists they were pulled from.

Acked-by: Pankaj Gupta <pankaj.gupta.linux@gmail.com>

>
>