Re: [PATCH 02/15] fs: gfs2: glock: Fix some deficient kernel-doc headers and demote non-conformant ones

[Andreas Gruenbacher]

On Thu, May 20, 2021 at 2:00 PM Lee Jones <lee.jones@xxxxxxxxxx> wrote:
> Fixes the following W=1 kernel build warning(s):
>
>  fs/gfs2/glock.c:365: warning: Function parameter or member 'gl' not described in 'do_error'
>  fs/gfs2/glock.c:365: warning: Function parameter or member 'ret' not described in 'do_error'
>  fs/gfs2/glock.c:461: warning: Function parameter or member 'new_state' not described in 'state_change'
>  fs/gfs2/glock.c:1277: warning: Function parameter or member 'delay' not described in 'handle_callback'
>  fs/gfs2/glock.c:1277: warning: Function parameter or member 'remote' not described in 'handle_callback'
>  fs/gfs2/glock.c:1578: warning: Function parameter or member 'p' not described in 'nq_m_sync'
>  fs/gfs2/glock.c:1993: warning: Excess function parameter 'wait' description in 'gfs2_gl_hash_clear'

What's that? Those warnings don't exist in mainline, and the two
warnings we have in mainline are fixed in for-next:

https://git.kernel.org/pub/scm/linux/kernel/git/gfs2/linux-gfs2.git/commit/?h=for-next&id=75069590915f2

Andreas

> Cc: Bob Peterson <rpeterso@xxxxxxxxxx>
> Cc: Andreas Gruenbacher <agruenba@xxxxxxxxxx>
> Cc: cluster-devel@xxxxxxxxxx
> Signed-off-by: Lee Jones <lee.jones@xxxxxxxxxx>
> ---
>  fs/gfs2/glock.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/fs/gfs2/glock.c b/fs/gfs2/glock.c
> index ea7fc5c641c7e..0b34f50b51331 100644
> --- a/fs/gfs2/glock.c
> +++ b/fs/gfs2/glock.c
> @@ -356,7 +356,7 @@ static void gfs2_holder_wake(struct gfs2_holder *gh)
>         }
>  }
>
> -/**
> +/*
>   * do_error - Something unexpected has happened during a lock request
>   * @gl: The glock
>   * @ret: The status from the DLM
> @@ -1263,7 +1263,7 @@ int gfs2_glock_async_wait(unsigned int num_gh, struct gfs2_holder *ghs)
>         return ret;
>  }
>
> -/**
> +/*
>   * handle_callback - process a demote request
>   * @gl: the glock
>   * @state: the state the caller wants us to change to
> --
> 2.31.1
>