Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

authored by

Brett Creeley and committed by
Jakub Kicinski
30ff01ee f85b1c7d

+1 -1
+1 -1
drivers/net/ethernet/amd/pds_core/auxbus.c
··· 11 11 * @pf_pdev: ptr to the PF driver struct 12 12 * @devname: name that includes service into, e.g. pds_core.vDPA 13 13 * 14 - * Return: 0 on success, or 14 + * Return: positive client ID (ci) on success, or 15 15 * negative for error 16 16 */ 17 17 int pds_client_register(struct pci_dev *pf_pdev, char *devname)