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

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

[Yang Li]

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'

Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 drivers/net/ethernet/amd/pds_core/auxbus.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/net/ethernet/amd/pds_core/auxbus.c b/drivers/net/ethernet/amd/pds_core/auxbus.c
index 8ff21d36ea42..e0d4b8d5159f 100644
--- a/drivers/net/ethernet/amd/pds_core/auxbus.c
+++ b/drivers/net/ethernet/amd/pds_core/auxbus.c
@@ -8,7 +8,7 @@
 
 /**
  * pds_client_register - Link the client to the firmware
- * @pf_pdev:	ptr to the PF driver struct
+ * @pf:	a pointer to the pdsc structure
  * @devname:	name that includes service into, e.g. pds_core.vDPA
  *
  * Return: positive client ID (ci) on success, or
@@ -48,7 +48,7 @@ EXPORT_SYMBOL_GPL(pds_client_register);
 
 /**
  * pds_client_unregister - Unlink the client from the firmware
- * @pf_pdev:	ptr to the PF driver struct
+ * @pf:	a pointer to the pdsc structure
  * @client_id:	id returned from pds_client_register()
  *
  * Return: 0 on success, or
-- 
2.20.1.7.g153144c

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

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to netdev/net-next.git (main)
by David S. Miller <davem@davemloft.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

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

[Brett Creeley]

On 8/20/2023 11:50 PM, patchwork-bot+netdevbpf@kernel.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@davemloft.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").

Thanks,

Brett

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

[Alex Williamson]

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

> On 8/20/2023 11:50 PM, patchwork-bot+netdevbpf@kernel.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@davemloft.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

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

[Jakub Kicinski]

On Mon, 21 Aug 2023 11:22:37 -0600 Alex Williamson wrote:
> 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,

Slightly tempting to just move the HEAD back by one commit but IDK what
consequences this would have for people who base their branches on
net-next. So I'll revert.