Commit 30ff01ee authored Aug 01, 2023 by Brett Creeley Committed by Jakub Kicinski Aug 02, 2023

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>

parent f85b1c7d

drivers/net/ethernet/amd/pds_core/auxbus.c

+1 −1

Original line number	Diff line number	Diff line
		@@ -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)