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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <92c8b22e-613e-7e8d-8cf9-b995494cf3f3@infradead.org>
Date:   Sun, 26 Sep 2021 15:57:21 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Andy Shevchenko <andriy.shevchenko@...ux.intel.com>,
        Jia He <justin.he@....com>
Cc:     Petr Mladek <pmladek@...e.com>,
        Steven Rostedt <rostedt@...dmis.org>,
        Sergey Senozhatsky <senozhatsky@...omium.org>,
        Rasmus Villemoes <linux@...musvillemoes.dk>,
        Jonathan Corbet <corbet@....net>,
        Alexander Viro <viro@...iv.linux.org.uk>,
        Linus Torvalds <torvalds@...ux-foundation.org>,
        "Peter Zijlstra (Intel)" <peterz@...radead.org>,
        Eric Biggers <ebiggers@...gle.com>,
        "Ahmed S. Darwish" <a.darwish@...utronix.de>,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        linux-fsdevel@...r.kernel.org,
        Matthew Wilcox <willy@...radead.org>,
        Christoph Hellwig <hch@...radead.org>, nd@....com
Subject: Re: [PATCH v7 1/5] d_path: fix Kernel doc validator complaints

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@...ux.intel.com>
> 

Acked-by: Randy Dunlap <rdunlap@...radead.org>

Can we get someone to merge this, please?

>> Fixes: ad08ae586586 ("d_path: introduce struct prepend_buffer")
>> Cc: Al Viro <viro@...iv.linux.org.uk>
>> Signed-off-by: Jia He <justin.he@....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