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

platform/x86: apple-gmux: Update apple_gmux_detect documentation

Commit fc83fbc80e1a ("platform/x86: apple-gmux: refactor gmux types")
neglected to update the documentation of apple_gmux_detect's arguments.
Update the documentation to reflect that commit's changes.

include/linux/apple-gmux.h:99: warning:
Function parameter or member 'type_ret' not described in 'apple_gmux_detect'
include/linux/apple-gmux.h:99: warning:
Excess function parameter 'indexed_ret' description in 'apple_gmux_detect'

Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Link: https://lore.kernel.org/lkml/20230309122822.77435e33@canb.auug.org.au/
Fixes: fc83fbc80e1a ("platform/x86: apple-gmux: refactor gmux types")
Signed-off-by: Orlando Chamberlain <orlandoch.dev@gmail.com>
Link: https://lore.kernel.org/r/20230309104353.10905-1-orlandoch.dev@gmail.com
Reviewed-by: Hans de Goede <hdegoede@redhat.com>
Signed-off-by: Hans de Goede <hdegoede@redhat.com>

authored by

Orlando Chamberlain and committed by
Hans de Goede
ad3d0ee8 d2e68321

+1 -1
+1 -1
include/linux/apple-gmux.h
··· 86 86 * apple_gmux_detect() - detect if gmux is built into the machine 87 87 * 88 88 * @pnp_dev: Device to probe or NULL to use the first matching device 89 - * @indexed_ret: Returns (by reference) if the gmux is indexed or not 89 + * @type_ret: Returns (by reference) the apple_gmux_type of the device 90 90 * 91 91 * Detect if a supported gmux device is present by actually probing it. 92 92 * This avoids the false positives returned on some models by