Linux-Fsdevel Archive on lore.kernel.org
help / color / mirror / Atom feed
* [PATCH] fs/xattr.c: fix kernel-doc warnings for setxattr & removexattr
@ 2020-08-31  0:30 Randy Dunlap
  2020-08-31  1:32 ` Andrew Morton
  0 siblings, 1 reply; 3+ messages in thread
From: Randy Dunlap @ 2020-08-31  0:30 UTC (permalink / raw)
  To: Linux FS Devel, Al Viro, Andrew Morton, Frank van der Linden,
	Chuck Lever

From: Randy Dunlap <rdunlap@infradead.org>

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

../fs/xattr.c:251: warning: Function parameter or member 'dentry' not described in '__vfs_setxattr_locked'
../fs/xattr.c:251: warning: Function parameter or member 'name' not described in '__vfs_setxattr_locked'
../fs/xattr.c:251: warning: Function parameter or member 'value' not described in '__vfs_setxattr_locked'
../fs/xattr.c:251: warning: Function parameter or member 'size' not described in '__vfs_setxattr_locked'
../fs/xattr.c:251: warning: Function parameter or member 'flags' not described in '__vfs_setxattr_locked'
../fs/xattr.c:251: warning: Function parameter or member 'delegated_inode' not described in '__vfs_setxattr_locked'
../fs/xattr.c:458: warning: Function parameter or member 'dentry' not described in '__vfs_removexattr_locked'
../fs/xattr.c:458: warning: Function parameter or member 'name' not described in '__vfs_removexattr_locked'
../fs/xattr.c:458: warning: Function parameter or member 'delegated_inode' not described in '__vfs_removexattr_locked'

Fixes: 08b5d5014a27 ("xattr: break delegations in {set,remove}xattr")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: stable@vger.kernel.org # v4.9+
Cc: linux-fsdevel@vger.kernel.org
Cc: Al Viro <viro@zeniv.linux.org.uk>
Cc: Frank van der Linden <fllinden@amazon.com>
Cc: Chuck Lever <chuck.lever@oracle.com>
---
 fs/xattr.c |   22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

--- lnx-59-rc3.orig/fs/xattr.c
+++ lnx-59-rc3/fs/xattr.c
@@ -232,15 +232,15 @@ int __vfs_setxattr_noperm(struct dentry
 }
 
 /**
- * __vfs_setxattr_locked: set an extended attribute while holding the inode
+ * __vfs_setxattr_locked - set an extended attribute while holding the inode
  * lock
  *
- *  @dentry - object to perform setxattr on
- *  @name - xattr name to set
- *  @value - value to set @name to
- *  @size - size of @value
- *  @flags - flags to pass into filesystem operations
- *  @delegated_inode - on return, will contain an inode pointer that
+ *  @dentry: object to perform setxattr on
+ *  @name: xattr name to set
+ *  @value: value to set @name to
+ *  @size: size of @value
+ *  @flags: flags to pass into filesystem operations
+ *  @delegated_inode: on return, will contain an inode pointer that
  *  a delegation was broken on, NULL if none.
  */
 int
@@ -443,12 +443,12 @@ __vfs_removexattr(struct dentry *dentry,
 EXPORT_SYMBOL(__vfs_removexattr);
 
 /**
- * __vfs_removexattr_locked: set an extended attribute while holding the inode
+ * __vfs_removexattr_locked - set an extended attribute while holding the inode
  * lock
  *
- *  @dentry - object to perform setxattr on
- *  @name - name of xattr to remove
- *  @delegated_inode - on return, will contain an inode pointer that
+ *  @dentry: object to perform setxattr on
+ *  @name: name of xattr to remove
+ *  @delegated_inode: on return, will contain an inode pointer that
  *  a delegation was broken on, NULL if none.
  */
 int


^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] fs/xattr.c: fix kernel-doc warnings for setxattr & removexattr
  2020-08-31  0:30 [PATCH] fs/xattr.c: fix kernel-doc warnings for setxattr & removexattr Randy Dunlap
@ 2020-08-31  1:32 ` Andrew Morton
  2020-08-31  3:16   ` Randy Dunlap
  0 siblings, 1 reply; 3+ messages in thread
From: Andrew Morton @ 2020-08-31  1:32 UTC (permalink / raw)
  To: Randy Dunlap; +Cc: Linux FS Devel, Al Viro, Frank van der Linden, Chuck Lever

On Sun, 30 Aug 2020 17:30:08 -0700 Randy Dunlap <rdunlap@infradead.org> wrote:

> From: Randy Dunlap <rdunlap@infradead.org>
> 
> Fix kernel-doc warnings in fs/xattr.c:
> 
> ../fs/xattr.c:251: warning: Function parameter or member 'dentry' not described in '__vfs_setxattr_locked'
> ../fs/xattr.c:251: warning: Function parameter or member 'name' not described in '__vfs_setxattr_locked'
> ../fs/xattr.c:251: warning: Function parameter or member 'value' not described in '__vfs_setxattr_locked'
> ../fs/xattr.c:251: warning: Function parameter or member 'size' not described in '__vfs_setxattr_locked'
> ../fs/xattr.c:251: warning: Function parameter or member 'flags' not described in '__vfs_setxattr_locked'
> ../fs/xattr.c:251: warning: Function parameter or member 'delegated_inode' not described in '__vfs_setxattr_locked'
> ../fs/xattr.c:458: warning: Function parameter or member 'dentry' not described in '__vfs_removexattr_locked'
> ../fs/xattr.c:458: warning: Function parameter or member 'name' not described in '__vfs_removexattr_locked'
> ../fs/xattr.c:458: warning: Function parameter or member 'delegated_inode' not described in '__vfs_removexattr_locked'
> 
> Fixes: 08b5d5014a27 ("xattr: break delegations in {set,remove}xattr")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: stable@vger.kernel.org # v4.9+

hm, are kerneldoc warning fixes -stable material?


^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] fs/xattr.c: fix kernel-doc warnings for setxattr & removexattr
  2020-08-31  1:32 ` Andrew Morton
@ 2020-08-31  3:16   ` Randy Dunlap
  0 siblings, 0 replies; 3+ messages in thread
From: Randy Dunlap @ 2020-08-31  3:16 UTC (permalink / raw)
  To: Andrew Morton; +Cc: Linux FS Devel, Al Viro, Frank van der Linden, Chuck Lever

On 8/30/20 6:32 PM, Andrew Morton wrote:
> On Sun, 30 Aug 2020 17:30:08 -0700 Randy Dunlap <rdunlap@infradead.org> wrote:
> 
>> From: Randy Dunlap <rdunlap@infradead.org>
>>
>> Fix kernel-doc warnings in fs/xattr.c:
>>
>> ../fs/xattr.c:251: warning: Function parameter or member 'dentry' not described in '__vfs_setxattr_locked'
>> ../fs/xattr.c:251: warning: Function parameter or member 'name' not described in '__vfs_setxattr_locked'
>> ../fs/xattr.c:251: warning: Function parameter or member 'value' not described in '__vfs_setxattr_locked'
>> ../fs/xattr.c:251: warning: Function parameter or member 'size' not described in '__vfs_setxattr_locked'
>> ../fs/xattr.c:251: warning: Function parameter or member 'flags' not described in '__vfs_setxattr_locked'
>> ../fs/xattr.c:251: warning: Function parameter or member 'delegated_inode' not described in '__vfs_setxattr_locked'
>> ../fs/xattr.c:458: warning: Function parameter or member 'dentry' not described in '__vfs_removexattr_locked'
>> ../fs/xattr.c:458: warning: Function parameter or member 'name' not described in '__vfs_removexattr_locked'
>> ../fs/xattr.c:458: warning: Function parameter or member 'delegated_inode' not described in '__vfs_removexattr_locked'
>>
>> Fixes: 08b5d5014a27 ("xattr: break delegations in {set,remove}xattr")
>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>> Cc: stable@vger.kernel.org # v4.9+
> 
> hm, are kerneldoc warning fixes -stable material?
> 

I don't know.
I only added that because the commit that it fixes had that Cc: line also.

From my (just now) reading of stable-kernel-rules.rst, the answer is No.

-- 
~Randy


^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2020-08-31  3:17 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-08-31  0:30 [PATCH] fs/xattr.c: fix kernel-doc warnings for setxattr & removexattr Randy Dunlap
2020-08-31  1:32 ` Andrew Morton
2020-08-31  3:16   ` Randy Dunlap

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).