[PATCH 0/2] platform/chrome: cros_ec_proto: Trivial kdoc fixes

[PATCH 0/2] platform/chrome: cros_ec_proto: Trivial kdoc fixes

[Thomas Weißschuh]

Two tiny fixes for kernel docs.

Signed-off-by: Thomas Weißschuh <linux@weissschuh.net>
---
Thomas Weißschuh (2):
      platform/chrome: cros_ec_proto: Fix cros_ec_get_host_event_wake_mask kdoc
      platform/chrome: cros_ec_proto: Fix cros_ec_get_host_command_version_mask kdoc

 drivers/platform/chrome/cros_ec_proto.c | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)
---
base-commit: 6d69b6c12fce479fde7bc06f686212451688a102
change-id: 20240524-cros_ec-cmd_versions-d2bdf3a6bdac

Best regards,
-- 
Thomas Weißschuh <linux@weissschuh.net>

[PATCH 1/2] platform/chrome: cros_ec_proto: Fix cros_ec_get_host_event_wake_mask kdoc

[Thomas Weißschuh]

Mark the documentation block as kernel doc and drop the documentation of
the non-existing parameter "@msg".

Signed-off-by: Thomas Weißschuh <linux@weissschuh.net>
---
 drivers/platform/chrome/cros_ec_proto.c | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/drivers/platform/chrome/cros_ec_proto.c b/drivers/platform/chrome/cros_ec_proto.c
index 945b1b15a04c..0006a3439644 100644
--- a/drivers/platform/chrome/cros_ec_proto.c
+++ b/drivers/platform/chrome/cros_ec_proto.c
@@ -239,13 +239,12 @@ int cros_ec_check_result(struct cros_ec_device *ec_dev,
 }
 EXPORT_SYMBOL(cros_ec_check_result);
 
-/*
+/**
  * cros_ec_get_host_event_wake_mask
  *
  * Get the mask of host events that cause wake from suspend.
  *
  * @ec_dev: EC device to call
- * @msg: message structure to use
  * @mask: result when function returns 0.
  *
  * LOCKING:

-- 
2.45.1

[PATCH 2/2] platform/chrome: cros_ec_proto: Fix cros_ec_get_host_command_version_mask kdoc

[Thomas Weißschuh]

Mark the documentation block as kernel doc and drop the documentation of
the non-existing parameter "@msg".

Signed-off-by: Thomas Weißschuh <linux@weissschuh.net>
---
 drivers/platform/chrome/cros_ec_proto.c | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/drivers/platform/chrome/cros_ec_proto.c b/drivers/platform/chrome/cros_ec_proto.c
index 0006a3439644..dcfc18fe1cdf 100644
--- a/drivers/platform/chrome/cros_ec_proto.c
+++ b/drivers/platform/chrome/cros_ec_proto.c
@@ -426,13 +426,12 @@ static int cros_ec_get_proto_info_legacy(struct cros_ec_device *ec_dev)
 	return ret;
 }
 
-/*
+/**
  * cros_ec_get_host_command_version_mask
  *
  * Get the version mask of a given command.
  *
  * @ec_dev: EC device to call
- * @msg: message structure to use
  * @cmd: command to get the version of.
  * @mask: result when function returns 0.
  *

-- 
2.45.1

Re: [PATCH 0/2] platform/chrome: cros_ec_proto: Trivial kdoc fixes

[patchwork-bot+chrome-platform]

Hello:

This series was applied to chrome-platform/linux.git (for-next)
by Tzung-Bi Shih <tzungbi@kernel.org>:

On Fri, 24 May 2024 10:33:32 +0200 you wrote:
> Two tiny fixes for kernel docs.
> 
> Signed-off-by: Thomas Weißschuh <linux@weissschuh.net>
> ---
> Thomas Weißschuh (2):
>       platform/chrome: cros_ec_proto: Fix cros_ec_get_host_event_wake_mask kdoc
>       platform/chrome: cros_ec_proto: Fix cros_ec_get_host_command_version_mask kdoc
> 
> [...]

Here is the summary with links:
  - [1/2] platform/chrome: cros_ec_proto: Fix cros_ec_get_host_event_wake_mask kdoc
    https://git.kernel.org/chrome-platform/c/d1019a74e0f5
  - [2/2] platform/chrome: cros_ec_proto: Fix cros_ec_get_host_command_version_mask kdoc
    https://git.kernel.org/chrome-platform/c/c48a71a88772

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html

Re: [PATCH 0/2] platform/chrome: cros_ec_proto: Trivial kdoc fixes

[patchwork-bot+chrome-platform]

Hello:

This series was applied to chrome-platform/linux.git (for-kernelci)
by Tzung-Bi Shih <tzungbi@kernel.org>:

On Fri, 24 May 2024 10:33:32 +0200 you wrote:
> Two tiny fixes for kernel docs.
> 
> Signed-off-by: Thomas Weißschuh <linux@weissschuh.net>
> ---
> Thomas Weißschuh (2):
>       platform/chrome: cros_ec_proto: Fix cros_ec_get_host_event_wake_mask kdoc
>       platform/chrome: cros_ec_proto: Fix cros_ec_get_host_command_version_mask kdoc
> 
> [...]

Here is the summary with links:
  - [1/2] platform/chrome: cros_ec_proto: Fix cros_ec_get_host_event_wake_mask kdoc
    https://git.kernel.org/chrome-platform/c/d1019a74e0f5
  - [2/2] platform/chrome: cros_ec_proto: Fix cros_ec_get_host_command_version_mask kdoc
    https://git.kernel.org/chrome-platform/c/c48a71a88772

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html