Skip to contentSkip to conversation

9p: Fix some kernel-doc comments

PATCH In review Yang Li 2 participants 2 messages Jun 15, 2022 9P file system

lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH 1/1 9p: Fix some kernel-doc comments

Remove warnings found by running scripts/kernel-doc,
which is caused by using 'make W=1'.
fs/9p/fid.c:35: warning: Function parameter or member 'pfid' not described in 'v9fs_fid_add' fs/9p/fid.c:35: warning: Excess function parameter 'fid' description in 'v9fs_fid_add' fs/9p/fid.c:80: warning: Function parameter or member 'pfid' not described in 'v9fs_open_fid_add' fs/9p/fid.c:80: warning: Excess function parameter 'fid' description in 'v9fs_open_fid_add'

---
 fs/9p/fid.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
fs/9p/fid.c +2 -2
index 289a85eae2ae..3a0f5963b8bd 100644
@@ -28,7 +28,7 @@ static inline void __add_fid(struct dentry *dentry, struct p9_fid *fid)
 /**
  * v9fs_fid_add - add a fid to a dentry
  * @dentry: dentry that the fid is being added to
- * @fid: fid to add
+ * @pfid: fid to add
  *
  */
 void v9fs_fid_add(struct dentry *dentry, struct p9_fid **pfid)
@@ -72,7 +72,7 @@ static struct p9_fid *v9fs_fid_find_inode(struct inode *inode, kuid_t uid)
 /**
  * v9fs_open_fid_add - add an open fid to an inode
  * @inode: inode that the fid is being added to
- * @fid: fid to add
+ * @pfid: fid to add
  *
  */
 
Signature · 1 line
2.20.1.7.g153144c
#1 lore raw

Yang Li wrote on Wed, Jun 15, 2022 at 09:20:39AM +0800:

Quoted 2 lines

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

ugh, I was told W=1 would become the default for net, but I guess it isn't question about that yet for fs...

Do you know how to make W=1 the default for part of the subtree?

Quoted 7 lines

fs/9p/fid.c:35: warning: Function parameter or member 'pfid' not described in 'v9fs_fid_add' fs/9p/fid.c:35: warning: Excess function parameter 'fid' description in 'v9fs_fid_add' fs/9p/fid.c:80: warning: Function parameter or member 'pfid' not described in 'v9fs_open_fid_add' fs/9p/fid.c:80: warning: Excess function parameter 'fid' description in 'v9fs_open_fid_add'

Will apply and add a note that it is NULLed out, thanks.

Quoted 26 lines
---
 fs/9p/fid.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
fs/9p/fid.c +2 -2
index 289a85eae2ae..3a0f5963b8bd 100644
@@ -28,7 +28,7 @@ static inline void __add_fid(struct dentry *dentry, struct p9_fid *fid)
 /**
  * v9fs_fid_add - add a fid to a dentry
  * @dentry: dentry that the fid is being added to
- * @fid: fid to add
+ * @pfid: fid to add
  *
  */
 void v9fs_fid_add(struct dentry *dentry, struct p9_fid **pfid)
@@ -72,7 +72,7 @@ static struct p9_fid *v9fs_fid_find_inode(struct inode *inode, kuid_t uid)
 /**
  * v9fs_open_fid_add - add an open fid to an inode
  * @inode: inode that the fid is being added to
- * @fid: fid to add
+ * @pfid: fid to add
  *
  */