diff options
author | Brett Creeley <brett.creeley@amd.com> | 2023-08-01 19:58:33 +0300 |
---|---|---|
committer | Jakub Kicinski <kuba@kernel.org> | 2023-08-02 22:28:32 +0300 |
commit | 30ff01ee99bc961e5f278f997e41ffb94785a88b (patch) | |
tree | 06c9a5a99fd3759ad713e4a8f2930275ba204a65 | |
parent | f85b1c7da776d0cb2b4509bdd7f406fe5607930b (diff) | |
download | linux-30ff01ee99bc961e5f278f997e41ffb94785a88b.tar.xz |
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@amd.com>
Signed-off-by: Shannon Nelson <shannon.nelson@amd.com>
Reviewed-by: Jesse Brandeburg <jesse.brandeburg@intel.com>
Link: https://lore.kernel.org/r/20230801165833.1622-1-brett.creeley@amd.com
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
-rw-r--r-- | drivers/net/ethernet/amd/pds_core/auxbus.c | 2 |
1 files changed, 1 insertions, 1 deletions
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) |