linux-kernel - Re: [PATCH] linux/dmaengine.h: fix a few 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 for Android: free password hash cracker in your pocket

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

Message-ID: <Z03enImvI+c7cZYw@vaman>
Date: Mon, 2 Dec 2024 21:51:48 +0530
From: Vinod Koul <vkoul@...nel.org>
To: Randy Dunlap <rdunlap@...radead.org>
Cc: linux-kernel@...r.kernel.org, Dan Williams <dan.j.williams@...el.com>,
	Dave Jiang <dave.jiang@...el.com>,
	Paul Cercueil <paul@...pouillou.net>, Nuno Sa <nuno.sa@...log.com>,
	dmaengine@...r.kernel.org
Subject: Re: [PATCH] linux/dmaengine.h: fix a few kernel-doc warnings

On 24-11-24, 22:20, Randy Dunlap wrote:
> 
> 
> On 11/24/24 10:15 PM, Randy Dunlap wrote:
> > The comment block for "Interleaved Transfer Request" should not begin
> > with "/**" since it is not in kernel-doc format.
> > 
> > Fix doc name for enum sum_check_flags.
> > 
> > Fix all (4) missing struct member warnings.
> > 
> > Use "Warning:" for one "Note:" in enum dma_desc_metadata_mode since
> > scripts/kernel-doc does not allow more than one Note:
> > per function or identifier description.
> > 
> > This leaves around 49 kernel-doc warnings like:
> >   include/linux/dmaengine.h:43: warning: Enum value 'DMA_OUT_OF_ORDER' not described in enum 'dma_status'
> > 
> > and another scripts/kernel-doc problem with it not being able to parse
> > some typedefs.
> > 
> > Fixes: b14dab792dee ("DMAEngine: Define interleaved transfer request api"), Jassi Brar
> 
> Oops, I left a note in the line above. I'll fix it for v2 after comments.

lgt,, I guess we can do a v2 now

> 
> > Fixes: ad283ea4a3ce ("async_tx: add sum check flags")
> > Fixes: 272420214d26 ("dmaengine: Add DMA_CTRL_REUSE")
> > Fixes: f067025bc676 ("dmaengine: add support to provide error result from a DMA transation")
> > Fixes: d38a8c622a1b ("dmaengine: prepare for generic 'unmap' data")
> > Fixes: 5878853fc938 ("dmaengine: Add API function dmaengine_prep_peripheral_dma_vec()")
> > Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> > Cc: Jassi Brar <jaswinder.singh@...aro.org>
> > Cc: Dan Williams <dan.j.williams@...el.com>
> > Cc: Dave Jiang <dave.jiang@...el.com>
> > Cc: Paul Cercueil <paul@...pouillou.net>
> > Cc: Nuno Sa <nuno.sa@...log.com>
> > Cc: Vinod Koul <vkoul@...nel.org>
> > Cc: dmaengine@...r.kernel.org
> > ---
> >  include/linux/dmaengine.h |   13 ++++++++++---
> >  1 file changed, 10 insertions(+), 3 deletions(-)
> 
> 
> -- 
> ~Randy
> 

-- 
~Vinod