gfs2: document ip in __gfs2_holder_init kernel-doc comment

[PATCH] gfs2: document ip in __gfs2_holder_init kernel-doc comment

Posted by Sukrut Heroorkar 3 months, 1 week ago

Building with W=1 reports:
Warning: fs/gfs2/glock.c:1248 function parameter 'ip' not described
in '__gfs2_holder_init'

The ip parameter was added when __gfs2_holder_init started saving the
gfs2_glock_nq_init caller's return address to gh_ip. This makes it
easier to backtrack which holder took the lock. Document @ip to silence
this warning.

Fixes: b016d9a84abd ("gfs2: Save ip from gfs2_glock_nq_init")
Signed-off-by: Sukrut Heroorkar <hsukrut3@gmail.com>
---
 fs/gfs2/glock.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/fs/gfs2/glock.c b/fs/gfs2/glock.c
index 91d0afec4087..bc6f236b899c 100644
--- a/fs/gfs2/glock.c
+++ b/fs/gfs2/glock.c
@@ -1163,7 +1163,7 @@ int gfs2_glock_get(struct gfs2_sbd *sdp, u64 number,
  * @state: the state we're requesting
  * @flags: the modifier flags
  * @gh: the holder structure
- *
+ * @ip: caller's return address for debugging
  */
 
 void __gfs2_holder_init(struct gfs2_glock *gl, unsigned int state, u16 flags,
-- 
2.43.0

Re: [PATCH] gfs2: document ip in __gfs2_holder_init kernel-doc comment

Posted by Andreas Gruenbacher 3 months, 1 week ago

On Mon, Oct 27, 2025 at 12:01 PM Sukrut Heroorkar <hsukrut3@gmail.com> wrote:
> Building with W=1 reports:
> Warning: fs/gfs2/glock.c:1248 function parameter 'ip' not described
> in '__gfs2_holder_init'
>
> The ip parameter was added when __gfs2_holder_init started saving the
> gfs2_glock_nq_init caller's return address to gh_ip. This makes it
> easier to backtrack which holder took the lock. Document @ip to silence
> this warning.
>
> Fixes: b016d9a84abd ("gfs2: Save ip from gfs2_glock_nq_init")
> Signed-off-by: Sukrut Heroorkar <hsukrut3@gmail.com>
> ---
>  fs/gfs2/glock.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/fs/gfs2/glock.c b/fs/gfs2/glock.c
> index 91d0afec4087..bc6f236b899c 100644
> --- a/fs/gfs2/glock.c
> +++ b/fs/gfs2/glock.c
> @@ -1163,7 +1163,7 @@ int gfs2_glock_get(struct gfs2_sbd *sdp, u64 number,
>   * @state: the state we're requesting
>   * @flags: the modifier flags
>   * @gh: the holder structure
> - *
> + * @ip: caller's return address for debugging
>   */
>
>  void __gfs2_holder_init(struct gfs2_glock *gl, unsigned int state, u16 flags,
> --
> 2.43.0
>

Applied, thanks.

Andreas