2021-12-31 04:34:24

by Yang Li

[permalink] [raw]
Subject: [PATCH -next] gfs2: Fix __gfs2_holder_init() kernel-doc comment

Add the description of @ip to remove warning found
by running scripts/kernel-doc, which is caused by
using 'make W=1'.
fs/gfs2/glock.c:1258: warning: Function parameter or member 'ip' not
described in '__gfs2_holder_init'

Reported-by: Abaci Robot <[email protected]>
Signed-off-by: Yang Li <[email protected]>
---
fs/gfs2/glock.c | 3 +++
1 file changed, 3 insertions(+)

diff --git a/fs/gfs2/glock.c b/fs/gfs2/glock.c
index b7ab8430333c..2f3f91e518de 100644
--- a/fs/gfs2/glock.c
+++ b/fs/gfs2/glock.c
@@ -1250,6 +1250,9 @@ 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: Get the return address of the current function, that is, the function
+ * is called by another function, and then when the function is finished,
+ * the return address is the address at that time.
*
*/

--
2.20.1.7.g153144c