* [PATCH net-next] pds_core: Fix documentation for pds_client_register
@ 2023-08-01 16:58 Brett Creeley
2023-08-01 17:34 ` Jesse Brandeburg
2023-08-02 19:40 ` patchwork-bot+netdevbpf
0 siblings, 2 replies; 3+ messages in thread
From: Brett Creeley @ 2023-08-01 16:58 UTC (permalink / raw)
To: kuba, davem, netdev; +Cc: alex.williamson, brett.creeley, shannon.nelson
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.
Signed-off-by: Brett Creeley <brett.creeley@amd.com>
Signed-off-by: Shannon Nelson <shannon.nelson@amd.com>
---
drivers/net/ethernet/amd/pds_core/auxbus.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/drivers/net/ethernet/amd/pds_core/auxbus.c b/drivers/net/ethernet/amd/pds_core/auxbus.c
index 561af8e5b3ea..6787a5fae908 100644
--- a/drivers/net/ethernet/amd/pds_core/auxbus.c
+++ b/drivers/net/ethernet/amd/pds_core/auxbus.c
@@ -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)
--
2.17.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH net-next] pds_core: Fix documentation for pds_client_register
2023-08-01 16:58 [PATCH net-next] pds_core: Fix documentation for pds_client_register Brett Creeley
@ 2023-08-01 17:34 ` Jesse Brandeburg
2023-08-02 19:40 ` patchwork-bot+netdevbpf
1 sibling, 0 replies; 3+ messages in thread
From: Jesse Brandeburg @ 2023-08-01 17:34 UTC (permalink / raw)
To: Brett Creeley, kuba, davem, netdev; +Cc: alex.williamson, shannon.nelson
On 8/1/2023 9:58 AM, Brett Creeley wrote:
> 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.
>
> Signed-off-by: Brett Creeley <brett.creeley@amd.com>
> Signed-off-by: Shannon Nelson <shannon.nelson@amd.com>
Reviewed-by: Jesse Brandeburg <jesse.brandeburg@intel.com>
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH net-next] pds_core: Fix documentation for pds_client_register
2023-08-01 16:58 [PATCH net-next] pds_core: Fix documentation for pds_client_register Brett Creeley
2023-08-01 17:34 ` Jesse Brandeburg
@ 2023-08-02 19:40 ` patchwork-bot+netdevbpf
1 sibling, 0 replies; 3+ messages in thread
From: patchwork-bot+netdevbpf @ 2023-08-02 19:40 UTC (permalink / raw)
To: Brett Creeley; +Cc: kuba, davem, netdev, alex.williamson, shannon.nelson
Hello:
This patch was applied to netdev/net-next.git (main)
by Jakub Kicinski <kuba@kernel.org>:
On Tue, 1 Aug 2023 09:58:33 -0700 you wrote:
> 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.
>
> Signed-off-by: Brett Creeley <brett.creeley@amd.com>
> Signed-off-by: Shannon Nelson <shannon.nelson@amd.com>
>
> [...]
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!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2023-08-02 19:40 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-08-01 16:58 [PATCH net-next] pds_core: Fix documentation for pds_client_register Brett Creeley
2023-08-01 17:34 ` Jesse Brandeburg
2023-08-02 19:40 ` patchwork-bot+netdevbpf
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).