* [PATCH 1/2] fs/namespace: corrent/improve kernel-doc notation
@ 2021-03-18 2:52 Randy Dunlap
2021-03-18 2:52 ` [PATCH 2/2] Documentation: filesystesm api-summary: add namespace.c Randy Dunlap
2021-03-31 20:24 ` [PATCH 1/2] fs/namespace: corrent/improve kernel-doc notation Jonathan Corbet
0 siblings, 2 replies; 4+ messages in thread
From: Randy Dunlap @ 2021-03-18 2:52 UTC (permalink / raw)
To: linux-kernel; +Cc: Randy Dunlap, Al Viro, Jonathan Corbet, linux-doc
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().
*/
^ permalink raw reply [flat|nested] 4+ messages in thread
* [PATCH 2/2] Documentation: filesystesm api-summary: add namespace.c
2021-03-18 2:52 [PATCH 1/2] fs/namespace: corrent/improve kernel-doc notation Randy Dunlap
@ 2021-03-18 2:52 ` Randy Dunlap
2021-03-31 20:24 ` [PATCH 1/2] fs/namespace: corrent/improve kernel-doc notation Jonathan Corbet
1 sibling, 0 replies; 4+ messages in thread
From: Randy Dunlap @ 2021-03-18 2:52 UTC (permalink / raw)
To: linux-kernel; +Cc: Randy Dunlap, Al Viro, Jonathan Corbet, linux-doc
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
===================
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH 1/2] fs/namespace: corrent/improve kernel-doc notation
2021-03-18 2:52 [PATCH 1/2] fs/namespace: corrent/improve kernel-doc notation Randy Dunlap
2021-03-18 2:52 ` [PATCH 2/2] Documentation: filesystesm api-summary: add namespace.c Randy Dunlap
@ 2021-03-31 20:24 ` Jonathan Corbet
2021-04-01 2:19 ` Al Viro
1 sibling, 1 reply; 4+ messages in thread
From: Jonathan Corbet @ 2021-03-31 20:24 UTC (permalink / raw)
To: Randy Dunlap, linux-kernel; +Cc: Randy Dunlap, Al Viro, linux-doc
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
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH 1/2] fs/namespace: corrent/improve kernel-doc notation
2021-03-31 20:24 ` [PATCH 1/2] fs/namespace: corrent/improve kernel-doc notation Jonathan Corbet
@ 2021-04-01 2:19 ` Al Viro
0 siblings, 0 replies; 4+ messages in thread
From: Al Viro @ 2021-04-01 2:19 UTC (permalink / raw)
To: Jonathan Corbet; +Cc: Randy Dunlap, linux-kernel, linux-doc
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>
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2021-04-01 2:20 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-03-18 2:52 [PATCH 1/2] fs/namespace: corrent/improve kernel-doc notation Randy Dunlap
2021-03-18 2:52 ` [PATCH 2/2] Documentation: filesystesm api-summary: add namespace.c Randy Dunlap
2021-03-31 20:24 ` [PATCH 1/2] fs/namespace: corrent/improve kernel-doc notation Jonathan Corbet
2021-04-01 2:19 ` Al Viro
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).