Skip to contentSkip to conversation

devpts: fix doc warnings in inode.c

PATCH New Baokun Li 1 participant 1 message Jun 5, 2021

lore
Share & tools
lore

Baokun Li

author
#0 lore raw

PATCH 1/1 devpts: fix doc warnings in inode.c

Fixes the following W=1 kernel build warning(s):

fs/devpts/inode.c:563: warning:
Function parameter or member 'fsi' not described in 'devpts_pty_new'
fs/devpts/inode.c:563: warning:
Excess function parameter 'ptmx_inode' description in 'devpts_pty_new'
fs/devpts/inode.c:563: warning:
Excess function parameter 'device' description in 'devpts_pty_new'
fs/devpts/inode.c:606: warning:
Function parameter or member 'dentry' not described in 'devpts_get_priv'
fs/devpts/inode.c:606: warning:
Excess function parameter 'pts_inode' description in 'devpts_get_priv'
fs/devpts/inode.c:619: warning:
Function parameter or member 'dentry' not described in 'devpts_pty_kill'
fs/devpts/inode.c:619: warning:
Excess function parameter 'inode' description in 'devpts_pty_kill'

---
 fs/devpts/inode.c | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)
fs/devpts/inode.c +3 -4
index 42e5a766d33c..d739f1b303f4 100644
@@ -552,8 +552,7 @@ void devpts_kill_index(struct pts_fs_info *fsi, int idx)
 
 /**
  * devpts_pty_new -- create a new inode in /dev/pts/
- * @ptmx_inode: inode of the master
- * @device: major+minor of the node to be created
+ * @fsi: pointer to pts_fs_info
  * @index: used as a name of the node
  * @priv: what's given back by devpts_get_priv
  *
@@ -598,7 +597,7 @@ struct dentry *devpts_pty_new(struct pts_fs_info *fsi, int index, void *priv)
 
 /**
  * devpts_get_priv -- get private data for a slave
- * @pts_inode: inode of the slave
+ * @dentry: dentry of the slave
  *
  * Returns whatever was passed as priv in devpts_pty_new for a given inode.
  */
@@ -611,7 +610,7 @@ void *devpts_get_priv(struct dentry *dentry)
 
 /**
  * devpts_pty_kill -- remove inode form /dev/pts/
- * @inode: inode of the slave to be removed
+ * @dentry: dentry of the slave to be removed
  *
  * This is an inverse operation of devpts_pty_new.
  */
Signature · 1 line
2.31.1