Commit d41b6035 authored by Jia He's avatar Jia He Committed by Linus Torvalds
Browse files

d_path: fix Kernel doc validator complaining 

Kernel doc validator complains:
  Function parameter or member 'p' not described in 'prepend_name'
  Excess function parameter 'buffer' description in 'prepend_name'

Link: https://lkml.kernel.org/r/20211011005614.26189-1-justin.he@arm.com


Fixes: ad08ae58 ("d_path: introduce struct prepend_buffer")
Signed-off-by: default avatarJia He <justin.he@arm.com>
Reviewed-by: default avatarAndy Shevchenko <andriy.shevchenko@linux.intel.com>
Acked-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Cc: Al Viro <viro@zeniv.linux.org.uk>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent d1cef29a

fs/d_path.c

+3 −5
Original line number Diff line number Diff line
@@ -77,8 +77,7 @@ static bool prepend(struct prepend_buffer *p, const char *str, int namelen) 


/**

 * prepend_name - prepend a pathname in front of current buffer pointer

 * @buffer: buffer pointer

 * @buflen: allocated length of the buffer

 * @p: prepend buffer which contains buffer pointer and allocated length

 * @name: name string and length qstr structure

 *

 * With RCU path tracing, it may race with d_move(). Use READ_ONCE() to
@@ -141,8 +140,7 @@ static int __prepend_path(const struct dentry *dentry, const struct mount *mnt, 
 * prepend_path - Prepend path string to a buffer

 * @path: the dentry/vfsmount to report

 * @root: root vfsmnt/dentry

 * @buffer: pointer to the end of the buffer

 * @buflen: pointer to buffer length

 * @p: prepend buffer which contains buffer pointer and allocated length

 *

 * The function will first try to write out the pathname without taking any

 * lock other than the RCU read lock to make sure that dentries won't go away.