diff mbox series

mm: fix compiler warning with make W=1

Message ID 1667884582-2465-1-git-send-email-quic_charante@quicinc.com
State New
Headers
Series mm: fix compiler warning with make W=1 |

Commit Message

Charan Teja Kalla Nov. 8, 2022, 5:16 a.m. UTC 
  Fix the below compiler warnings reported with 'make W=1 mm/'.
mm/page_ext.c:178: warning: Function parameter or member 'page_ext' not
described in 'page_ext_put'.

Reported-by: Vlastimil Babka <vbabka@suse.cz>
Signed-off-by: Charan Teja Kalla <quic_charante@quicinc.com>
---
 mm/page_ext.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Pavan Kondeti Nov. 8, 2022, 6:17 a.m. UTC | #1 
Hi Charan,

On Tue, Nov 08, 2022 at 10:46:22AM +0530, Charan Teja Kalla wrote:
> Fix the below compiler warnings reported with 'make W=1 mm/'.
> mm/page_ext.c:178: warning: Function parameter or member 'page_ext' not
> described in 'page_ext_put'.
> 
> Reported-by: Vlastimil Babka <vbabka@suse.cz>
> Signed-off-by: Charan Teja Kalla <quic_charante@quicinc.com>
> ---
>  mm/page_ext.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/mm/page_ext.c b/mm/page_ext.c
> index affe8024..ddf1968 100644
> --- a/mm/page_ext.c
> +++ b/mm/page_ext.c
> @@ -166,7 +166,7 @@ struct page_ext *page_ext_get(struct page *page)
>  
>  /**
>   * page_ext_put() - Working with page extended information is done.
> - * @page_ext - Page extended information received from page_ext_get().
> + * @page_ext: Page extended information received from page_ext_get().
>   *
>   * The page extended information of the page may not be valid after this
>   * function is called.
> 

Looks good to me. Your patch fixes the warning emitted earlier by

./scripts/kernel-doc -none mm/page_ext.c
mm/page_ext.c:178: warning: Function parameter or member 'page_ext' not described in 'page_ext_put'

one nit comment on the changelog summary

mm: fix compiler warning with make W=1

Can you make it more specific like "mm/page_exit: fix kernel doc warning in page_ext_put()"

Thanks,
Pavan
Vlastimil Babka Nov. 8, 2022, 12:47 p.m. UTC | #2 
On 11/8/22 06:16, Charan Teja Kalla wrote:
> Fix the below compiler warnings reported with 'make W=1 mm/'.
> mm/page_ext.c:178: warning: Function parameter or member 'page_ext' not
> described in 'page_ext_put'.
> 
> Reported-by: Vlastimil Babka <vbabka@suse.cz>

Reported-and-tested-by: Vlastimil Babka <vbabka@suse.cz>

> Signed-off-by: Charan Teja Kalla <quic_charante@quicinc.com>

Thanks!

> ---
>   mm/page_ext.c | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/mm/page_ext.c b/mm/page_ext.c
> index affe8024..ddf1968 100644
> --- a/mm/page_ext.c
> +++ b/mm/page_ext.c
> @@ -166,7 +166,7 @@ struct page_ext *page_ext_get(struct page *page)
>   
>   /**
>    * page_ext_put() - Working with page extended information is done.
> - * @page_ext - Page extended information received from page_ext_get().
> + * @page_ext: Page extended information received from page_ext_get().
>    *
>    * The page extended information of the page may not be valid after this
>    * function is called.
diff mbox series

Patch

diff --git a/mm/page_ext.c b/mm/page_ext.c
index affe8024..ddf1968 100644
--- a/mm/page_ext.c
+++ b/mm/page_ext.c
@@ -166,7 +166,7 @@  struct page_ext *page_ext_get(struct page *page)
 
 /**
  * page_ext_put() - Working with page extended information is done.
- * @page_ext - Page extended information received from page_ext_get().
+ * @page_ext: Page extended information received from page_ext_get().
  *
  * The page extended information of the page may not be valid after this
  * function is called.