* [PATCH] gfs2: document ip in __gfs2_holder_init kernel-doc comment
@ 2025-10-27 11:00 Sukrut Heroorkar
2025-10-28 10:07 ` Andreas Gruenbacher
0 siblings, 1 reply; 2+ messages in thread
From: Sukrut Heroorkar @ 2025-10-27 11:00 UTC (permalink / raw)
To: Andreas Gruenbacher, Bob Peterson, open list:GFS2 FILE SYSTEM,
open list
Cc: shuah, david.hunter.linux, Sukrut Heroorkar
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
^ permalink raw reply related [flat|nested] 2+ messages in thread* Re: [PATCH] gfs2: document ip in __gfs2_holder_init kernel-doc comment
2025-10-27 11:00 [PATCH] gfs2: document ip in __gfs2_holder_init kernel-doc comment Sukrut Heroorkar
@ 2025-10-28 10:07 ` Andreas Gruenbacher
0 siblings, 0 replies; 2+ messages in thread
From: Andreas Gruenbacher @ 2025-10-28 10:07 UTC (permalink / raw)
To: Sukrut Heroorkar
Cc: open list:GFS2 FILE SYSTEM, open list, shuah, david.hunter.linux
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
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2025-10-28 10:08 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-10-27 11:00 [PATCH] gfs2: document ip in __gfs2_holder_init kernel-doc comment Sukrut Heroorkar
2025-10-28 10:07 ` Andreas Gruenbacher
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox