linux-kernel - Re: [PATCH] remoteproc: fix kernel-doc warnings

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] [day] [month] [year] [list]

Date:   Wed, 12 Feb 2020 17:01:28 +0100
From:   Arnaud POULIQUEN <arnaud.pouliquen@...com>
To:     Randy Dunlap <rdunlap@...radead.org>,
        Bjorn Andersson <bjorn.andersson@...aro.org>,
        Ohad Ben-Cohen <ohad@...ery.com>,
        Mathieu Poirier <mathieu.poirier@...aro.org>
CC:     <linux-remoteproc@...r.kernel.org>, <linux-kernel@...r.kernel.org>,
        <linux-stm32@...md-mailman.stormreply.com>
Subject: Re: [PATCH] remoteproc: fix kernel-doc warnings

Hi Randy

On 2/12/20 4:54 PM, Randy Dunlap wrote:
> Hi,
> 
> kernel-doc supports "..." as a function argument for varargs.
> See Documentation/doc-guide/kernel-doc.rst:
> 
> "If a function has a variable number of arguments, its description should
> be written in kernel-doc notation as::
> 
>       * @...: description"
I missed it, thanks for pointing it out!

Regards
Arnaud
> 
> 
> So the below could be done as:
> 
> On 2/12/20 1:32 AM, Arnaud Pouliquen wrote:
>> diff --git a/drivers/remoteproc/remoteproc_core.c b/drivers/remoteproc/remoteproc_core.c
>> index 097f33e4f1f3..5f9a5812505c 100644
>> --- a/drivers/remoteproc/remoteproc_core.c
>> +++ b/drivers/remoteproc/remoteproc_core.c
>> @@ -224,7 +224,7 @@ EXPORT_SYMBOL(rproc_da_to_va);
>>  /**
>>   * rproc_find_carveout_by_name() - lookup the carveout region by a name
>>   * @rproc: handle of a remote processor
>> - * @name,..: carveout name to find (standard printf format)
>> + * @name: carveout name to find (standard printf format)
> 
>  * @name: carveout name to find
>  * @...: standard printf format of args to search for carveout name
> 
> although I'm not so sure about the descriptions there.
> 
>>   *
>>   * Platform driver has the capability to register some pre-allacoted carveout
>>   * (physically contiguous memory regions) before rproc firmware loading and
> 
> 
> thanks for the kernel-doc update.
>