[<prev] [next>] [thread-next>] [day] [month] [year] [list]
Message-ID: <20230801165833.1622-1-brett.creeley@amd.com>
Date: Tue, 1 Aug 2023 09:58:33 -0700
From: Brett Creeley <brett.creeley@....com>
To: <kuba@...nel.org>, <davem@...emloft.net>, <netdev@...r.kernel.org>
CC: <alex.williamson@...hat.com>, <brett.creeley@....com>,
<shannon.nelson@....com>
Subject: [PATCH net-next] 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.
Signed-off-by: Brett Creeley <brett.creeley@....com>
Signed-off-by: Shannon Nelson <shannon.nelson@....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
Powered by blists - more mailing lists