[1/2] fs/namespace.c: fix kernel-doc warnings and add kernel-doc
diff mbox series

Message ID 2475df7a-2c6a-76cd-66a1-5872df0212a7@infradead.org
State New
Headers show
Series
  • [1/2] fs/namespace.c: fix kernel-doc warnings and add kernel-doc
Related show

Commit Message

Randy Dunlap Jan. 31, 2020, 5:25 a.m. UTC
From: Randy Dunlap <rdunlap@infradead.org>

Fix kernel-doc warnings in fs/namespace.c:

./fs/namespace.c:1309: warning: Function parameter or member 'm' not described in 'may_umount_tree'
./fs/namespace.c:1309: warning: Excess function parameter 'mnt' description in 'may_umount_tree'
./fs/namespace.c:1872: warning: Function parameter or member 'path' not described in 'clone_private_mount'

Also convert path_is_mountpoint() comments to kernel-doc.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Al Viro <viro@zeniv.linux.org.uk>
---
 fs/namespace.c |   14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)

Patch
diff mbox series

--- linux-next-20200130.orig/fs/namespace.c
+++ linux-next-20200130/fs/namespace.c
@@ -1205,8 +1205,9 @@  struct vfsmount *mntget(struct vfsmount
 }
 EXPORT_SYMBOL(mntget);
 
-/* path_is_mountpoint() - Check if path is a mount in the current
- *                          namespace.
+/**
+ * path_is_mountpoint() - Check if path is a mount in the current namespace.
+ * @path: path to check
  *
  *  d_mountpoint() can only be used reliably to establish if a dentry is
  *  not mounted in any namespace and that common case is handled inline.
@@ -1298,7 +1299,7 @@  const struct seq_operations mounts_op =
 
 /**
  * may_umount_tree - check if a mount tree is busy
- * @mnt: root of mount tree
+ * @m: root of mount tree
  *
  * This is called to check if a tree of mounts has any
  * open files, pwds, chroots or sub mounts that are
@@ -1860,10 +1861,11 @@  void drop_collected_mounts(struct vfsmou
 
 /**
  * clone_private_mount - create a private clone of a path
+ * @path: path to clone
  *
- * This creates a new vfsmount, which will be the clone of @path.  The new will
- * not be attached anywhere in the namespace and will be private (i.e. changes
- * to the originating mount won't be propagated into this).
+ * This creates a new vfsmount, which will be the clone of @path.  The new mount
+ * will not be attached anywhere in the namespace and will be private (i.e.
+ * changes to the originating mount won't be propagated into this).
  *
  * Release with mntput().
  */