pds_core: Fix documentation for pds_client_register
Subsystems (3)
Brett Creeley
maintainerPATCH 1/1 pds_core: Fix documentation for pds_client_register
The documentation above pds_client_register states that it returns 0 on success and negative on error. However, it actually returns a positive client ID on success and negative on error. Fix the documentation to state exactly that.
--- drivers/net/ethernet/amd/pds_core/auxbus.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/net/ethernet/amd/pds_core/auxbus.c +1 -1
@@ -11,7 +11,7 @@* @pf_pdev: ptr to the PF driver struct * @devname: name that includes service into, e.g. pds_core.vDPA * -* Return: 0 on success, or +* Return: positive client ID (ci) on success, or * negative for error */ int pds_client_register (struct pci_dev *pf_pdev,char *devname)
Signature · 1 line
2.17.1
Quoted 7 lines · Brett Creeley
The documentation above
pds_client_registerstates that it returns 0 on success and negative on error. However, it actually returns a positive client ID on success and negative on error. Fix the documentation to state exactly that.Signed-off-by Brett Creeley <[email protected]>Signed-off-by Shannon Nelson <[email protected]>
This patch was applied to netdev/net-next.git (main) by Jakub Kicinski <[email protected]>:
Hello:
This patch was applied to netdev/net-next.git (main) by Jakub Kicinski <[email protected]>:
Quoted 9 lines · On Tue, 1 Aug 2023 09:58:33 -0700 you wrote:
The documentation above
pds_client_registerstates that it returns 0 on success and negative on error. However, it actually returns a positive client ID on success and negative on error. Fix the documentation to state exactly that.Signed-off-by Brett Creeley <[email protected]>Signed-off-by Shannon Nelson <[email protected]>[...]
Here is the summary with links:
- [net-next] pds_core: Fix documentation for pds_client_register
https://git.kernel.org/netdev/net-next/c/30ff01ee99bc
You are awesome, thank you!
Signature · 2 lines
Deet-doot-dot, I am a bot. https://korg.docs.kernel.org/patchwork/pwbot.html