linux-kernel - Re: [PATCH net-next] pds_core: Fix some kernel-doc comments

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: <20230821112237.105872b5.alex.williamson@redhat.com>
Date:   Mon, 21 Aug 2023 11:22:37 -0600
From:   Alex Williamson <alex.williamson@...hat.com>
To:     Brett Creeley <bcreeley@....com>
Cc:     patchwork-bot+netdevbpf@...nel.org,
        Yang Li <yang.lee@...ux.alibaba.com>, edumazet@...gle.com,
        davem@...emloft.net, kuba@...nel.org, pabeni@...hat.com,
        shannon.nelson@....com, brett.creeley@....com,
        netdev@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH net-next] pds_core: Fix some kernel-doc comments

On Mon, 21 Aug 2023 10:05:21 -0700
Brett Creeley <bcreeley@....com> wrote:

> On 8/20/2023 11:50 PM, patchwork-bot+netdevbpf@...nel.org wrote:
> > Caution: This message originated from an External Source. Use proper caution when opening attachments, clicking links, or responding.
> > 
> > 
> > Hello:
> > 
> > This patch was applied to netdev/net-next.git (main)
> > by David S. Miller <davem@...emloft.net>:
> > 
> > On Mon, 21 Aug 2023 09:55:37 +0800 you wrote:  
> >> Fix some kernel-doc comments to silence the warnings:
> >>
> >> drivers/net/ethernet/amd/pds_core/auxbus.c:18: warning: Function parameter or member 'pf' not described in 'pds_client_register'
> >> drivers/net/ethernet/amd/pds_core/auxbus.c:18: warning: Excess function parameter 'pf_pdev' description in 'pds_client_register'
> >> drivers/net/ethernet/amd/pds_core/auxbus.c:58: warning: Function parameter or member 'pf' not described in 'pds_client_unregister'
> >> drivers/net/ethernet/amd/pds_core/auxbus.c:58: warning: Excess function parameter 'pf_pdev' description in 'pds_client_unregister'
> >>
> >> [...]  
> > 
> > Here is the summary with links:
> >    - [net-next] pds_core: Fix some kernel-doc comments
> >      https://git.kernel.org/netdev/net-next/c/cb39c35783f2
> > 
> > You are awesome, thank you!
> > --
> > Deet-doot-dot, I am a bot.
> > https://korg.docs.kernel.org/patchwork/pwbot.html
> > 
> >   
> 
> FYI - there might be some conflicts here as this was already fixed on 
> Alex Williamson's vfio next branch. I don't fully understand how all 
> things get merged into v6.6, so I just wanted to update here.
> 
> On vfio's next branch this was fixed by: 06d220f13b1f ("pds_core: Fix 
> function header descriptions"). It also has a pre-requisite patch that 
> actually introduced the warning: b021d05e106e ("pds_core: Require 
> callers of register/unregister to pass PF drvdata").

Right, the issue was introduced by:

https://lore.kernel.org/all/20230807205755.29579-4-brett.creeley@amd.com/

which exists in the vfio next branch as:

b021d05e106e ("pds_core: Require callers of register/unregister to pass PF drvdata")

The problem doesn't actually exist in the stand alone net-next branch,
so I felt confident in taking Brett's fix from here:

https://lore.kernel.org/all/20230817224212.14266-1-brett.creeley@amd.com/

which is currently in the vfio next branch:

06d220f13b1f ("pds_core: Fix function header descriptions")

Additionally this includes proper attributes and fixes tags.

I'm sure Linus can fixup the conflict, but a preferable solution might
be to drop the patch from Yang Li from net-next.  Thanks,

Alex