[PATCH 1/1] apple-gmux: Update apple_gmux_detect documentation

[PATCH 1/1] apple-gmux: Update apple_gmux_detect documentation

[Orlando Chamberlain]

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>
---
 include/linux/apple-gmux.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/apple-gmux.h b/include/linux/apple-gmux.h
index 272f63f8fd7c..a7a7d430024b 100644
--- a/include/linux/apple-gmux.h
+++ b/include/linux/apple-gmux.h
@@ -86,7 +86,7 @@ static inline bool apple_gmux_is_mmio(unsigned long iostart)
  * apple_gmux_detect() - detect if gmux is built into the machine
  *
  * @pnp_dev:     Device to probe or NULL to use the first matching device
- * @indexed_ret: Returns (by reference) if the gmux is indexed or not
+ * @type_ret: Returns (by reference) the apple_gmux_type of the device
  *
  * Detect if a supported gmux device is present by actually probing it.
  * This avoids the false positives returned on some models by
-- 
2.39.2

Re: [PATCH 1/1] apple-gmux: Update apple_gmux_detect documentation

[Hans de Goede]

Hi,

On 3/9/23 11:43, Orlando Chamberlain wrote:
> 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>

Thank you for your patch, I've applied this patch to my review-hans 
branch:
https://git.kernel.org/pub/scm/linux/kernel/git/pdx86/platform-drivers-x86.git/log/?h=review-hans

Note it will show up in my review-hans branch once I've pushed my
local branch there, which might take a while.

Once I've run some tests on this branch the patches there will be
added to the platform-drivers-x86/for-next branch and eventually
will be included in the pdx86 pull-request to Linus for the next
merge-window.

Regards,

Hans


> ---
>  include/linux/apple-gmux.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/linux/apple-gmux.h b/include/linux/apple-gmux.h
> index 272f63f8fd7c..a7a7d430024b 100644
> --- a/include/linux/apple-gmux.h
> +++ b/include/linux/apple-gmux.h
> @@ -86,7 +86,7 @@ static inline bool apple_gmux_is_mmio(unsigned long iostart)
>   * apple_gmux_detect() - detect if gmux is built into the machine
>   *
>   * @pnp_dev:     Device to probe or NULL to use the first matching device
> - * @indexed_ret: Returns (by reference) if the gmux is indexed or not
> + * @type_ret: Returns (by reference) the apple_gmux_type of the device
>   *
>   * Detect if a supported gmux device is present by actually probing it.
>   * This avoids the false positives returned on some models by