[PATCH -next] mm/munlock: Fix kernel-doc formatting issues

[PATCH -next] mm/munlock: Fix kernel-doc formatting issues

[Yang Li]

Some functions had kernel-doc that used a hash instead of a colon to
separate the parameter name from the one line description.

Replacing them to remove warnings found by running scripts/kernel-doc,
which is caused by using 'make W=1'.

mm/mlock.c:218: warning: Function parameter or member 'page' not
described in 'mlock_page'
mm/mlock.c:240: warning: Function parameter or member 'page' not
described in 'mlock_new_page'
mm/mlock.c:260: warning: Function parameter or member 'page' not
described in 'munlock_page'

Reported-by: Abaci Robot <abaci@linux.alibaba.com>
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 mm/mlock.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/mm/mlock.c b/mm/mlock.c
index d50d48961b22..7fb97e1242f1 100644
--- a/mm/mlock.c
+++ b/mm/mlock.c
@@ -212,7 +212,7 @@ bool need_mlock_page_drain(int cpu)
 
 /**
  * mlock_page - mlock a page already on (or temporarily off) LRU
- * @page - page to be mlocked, either a normal page or a THP head.
+ * @page: page to be mlocked, either a normal page or a THP head.
  */
 void mlock_page(struct page *page)
 {
@@ -234,7 +234,7 @@ void mlock_page(struct page *page)
 
 /**
  * mlock_new_page - mlock a newly allocated page not yet on LRU
- * @page - page to be mlocked, either a normal page or a THP head.
+ * @page: page to be mlocked, either a normal page or a THP head.
  */
 void mlock_new_page(struct page *page)
 {
@@ -254,7 +254,7 @@ void mlock_new_page(struct page *page)
 
 /**
  * munlock_page - munlock a page
- * @page - page to be munlocked, either a normal page or a THP head.
+ * @page: page to be munlocked, either a normal page or a THP head.
  */
 void munlock_page(struct page *page)
 {
-- 
2.20.1.7.g153144c

Re: [PATCH -next] mm/munlock: Fix kernel-doc formatting issues

[Hugh Dickins]

On Thu, 10 Feb 2022, Yang Li wrote:

> Some functions had kernel-doc that used a hash instead of a colon to
> separate the parameter name from the one line description.
> 
> Replacing them to remove warnings found by running scripts/kernel-doc,
> which is caused by using 'make W=1'.
> 
> mm/mlock.c:218: warning: Function parameter or member 'page' not
> described in 'mlock_page'
> mm/mlock.c:240: warning: Function parameter or member 'page' not
> described in 'mlock_new_page'
> mm/mlock.c:260: warning: Function parameter or member 'page' not
> described in 'munlock_page'
> 
> Reported-by: Abaci Robot <abaci@linux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>

Oh, great, thanks.  I thought I was just following what was already
there, but now I look closer, yes, the ones with "/*" at the top had
dashes and the ones with "/**" at the top had colons: apparently I fell
for the wrong combination - sorry.

Hugh

> ---
>  mm/mlock.c | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/mm/mlock.c b/mm/mlock.c
> index d50d48961b22..7fb97e1242f1 100644
> --- a/mm/mlock.c
> +++ b/mm/mlock.c
> @@ -212,7 +212,7 @@ bool need_mlock_page_drain(int cpu)
>  
>  /**
>   * mlock_page - mlock a page already on (or temporarily off) LRU
> - * @page - page to be mlocked, either a normal page or a THP head.
> + * @page: page to be mlocked, either a normal page or a THP head.
>   */
>  void mlock_page(struct page *page)
>  {
> @@ -234,7 +234,7 @@ void mlock_page(struct page *page)
>  
>  /**
>   * mlock_new_page - mlock a newly allocated page not yet on LRU
> - * @page - page to be mlocked, either a normal page or a THP head.
> + * @page: page to be mlocked, either a normal page or a THP head.
>   */
>  void mlock_new_page(struct page *page)
>  {
> @@ -254,7 +254,7 @@ void mlock_new_page(struct page *page)
>  
>  /**
>   * munlock_page - munlock a page
> - * @page - page to be munlocked, either a normal page or a THP head.
> + * @page: page to be munlocked, either a normal page or a THP head.
>   */
>  void munlock_page(struct page *page)
>  {
> -- 
> 2.20.1.7.g153144c