Re: [PATCH v7 1/5] d_path: fix Kernel doc validator complaints

[Randy Dunlap <rdunlap@infradead.org>]

On 9/26/21 3:57 PM, Randy Dunlap wrote:
> On 7/15/21 3:34 AM, Andy Shevchenko wrote:
>> On Thu, Jul 15, 2021 at 09:14:03AM +0800, Jia He wrote:
>>> Kernel doc validator complains:
>>>    Function parameter or member 'p' not described in 'prepend_name'
>>>    Excess function parameter 'buffer' description in 'prepend_name'
>>
>> Yup!
>> Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
>>
> 
> Acked-by: Randy Dunlap <rdunlap@infradead.org>
> 
> Can we get someone to merge this, please?

Ho hum.  Justin, please resubmit your patch with Andy's Reviewed-by:
and my Acked-by:.  Send it to Andrew Morton and ask him to merge it.

Thanks.


(cf. https://lore.kernel.org/all/20210628014613.11296-1-rdunlap@infradead.org/
from 2021-06-27)

>>> Fixes: ad08ae586586 ("d_path: introduce struct prepend_buffer")
>>> Cc: Al Viro <viro@zeniv.linux.org.uk>
>>> Signed-off-by: Jia He <justin.he@arm.com>
>>> ---
>>>   fs/d_path.c | 8 +++-----
>>>   1 file changed, 3 insertions(+), 5 deletions(-)
>>>
>>> diff --git a/fs/d_path.c b/fs/d_path.c
>>> index 23a53f7b5c71..4eb31f86ca88 100644
>>> --- a/fs/d_path.c
>>> +++ b/fs/d_path.c
>>> @@ -33,9 +33,8 @@ static void 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
>>> - * @name:   name string and length qstr structure
>>> + * @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
>>>    * make sure that either the old or the new name pointer and length are
>>> @@ -108,8 +107,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.
>>> -- 
> 
> 


-- 
~Randy