[PATCH 1/2] fs/namespace: corrent/improve kernel-doc notation

[PATCH 1/2] fs/namespace: corrent/improve kernel-doc notation

[Randy Dunlap]

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

./fs/namespace.c:1379: warning: Function parameter or member 'm' not described in 'may_umount_tree'
./fs/namespace.c:1379: warning: Excess function parameter 'mnt' description in 'may_umount_tree'
./fs/namespace.c:1950: 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>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
---
Jon, Al has OK-ed you to merge this patch (and the next one, please).

 fs/namespace.c |   14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)

--- linux-next-20210317.orig/fs/namespace.c
+++ linux-next-20210317/fs/namespace.c
@@ -1242,8 +1242,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.
@@ -1369,7 +1370,7 @@ void mnt_cursor_del(struct mnt_namespace
 
 /**
  * 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
@@ -1939,10 +1940,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().
  */

[PATCH 2/2] Documentation: filesystesm api-summary: add namespace.c

[Randy Dunlap]

Add fs/namespace.c to the filesystems api-summary docbook.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Alexander Viro <viro@zeniv.linux.org.uk>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
---
 Documentation/filesystems/api-summary.rst |    3 +++
 1 file changed, 3 insertions(+)

--- linux-next-20210317.orig/Documentation/filesystems/api-summary.rst
+++ linux-next-20210317/Documentation/filesystems/api-summary.rst
@@ -101,6 +101,9 @@ Other Functions
 .. kernel-doc:: fs/xattr.c
    :export:
 
+.. kernel-doc:: fs/namespace.c
+   :export:
+
 The proc filesystem
 ===================
 

Re: [PATCH 1/2] fs/namespace: corrent/improve kernel-doc notation

[Jonathan Corbet]

Randy Dunlap <rdunlap@infradead.org> writes:

> Fix kernel-doc warnings in fs/namespace.c:
>
> ./fs/namespace.c:1379: warning: Function parameter or member 'm' not described in 'may_umount_tree'
> ./fs/namespace.c:1379: warning: Excess function parameter 'mnt' description in 'may_umount_tree'
> ./fs/namespace.c:1950: 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>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: linux-doc@vger.kernel.org
> ---
> Jon, Al has OK-ed you to merge this patch (and the next one, please).
>
>  fs/namespace.c |   14 ++++++++------
>  1 file changed, 8 insertions(+), 6 deletions(-)

An actual acked-by would have been nice, oh well.  Meanwhile, I've
applied them with fixes to the typos in both changelogs :)

Thanks,

jon

Re: [PATCH 1/2] fs/namespace: corrent/improve kernel-doc notation

[Al Viro]

On Wed, Mar 31, 2021 at 02:24:18PM -0600, Jonathan Corbet wrote:
> Randy Dunlap <rdunlap@infradead.org> writes:
> 
> > Fix kernel-doc warnings in fs/namespace.c:
> >
> > ./fs/namespace.c:1379: warning: Function parameter or member 'm' not described in 'may_umount_tree'
> > ./fs/namespace.c:1379: warning: Excess function parameter 'mnt' description in 'may_umount_tree'
> > ./fs/namespace.c:1950: 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>
> > Cc: Jonathan Corbet <corbet@lwn.net>
> > Cc: linux-doc@vger.kernel.org
> > ---
> > Jon, Al has OK-ed you to merge this patch (and the next one, please).
> >
> >  fs/namespace.c |   14 ++++++++------
> >  1 file changed, 8 insertions(+), 6 deletions(-)
> 
> An actual acked-by would have been nice, oh well.  Meanwhile, I've
> applied them with fixes to the typos in both changelogs :)

Generally speaking, I'm only glad to leave handling kernel-doc patches
to somebody else, especially when they are that trivial ;-)

Anyway,
Acked-by: Al Viro <viro@zeniv.linux.org.uk>