Chrome platform driver development
 help / color / mirror / Atom feed
From: Tzung-Bi Shih <tzungbi@kernel.org>
To: bleung@chromium.org, groeck@chromium.org
Cc: chrome-platform@lists.linux.dev, tzungbi@kernel.org
Subject: [PATCH 4/4] platform/chrome: fix kernel-doc warnings for cros_ec_command
Date: Wed, 11 Jan 2023 13:57:28 +0800	[thread overview]
Message-ID: <20230111055728.708990-5-tzungbi@kernel.org> (raw)
In-Reply-To: <20230111055728.708990-1-tzungbi@kernel.org>

Fix the following kernel-doc warnings:

$ ./scripts/kernel-doc -none \
	include/linux/platform_data/cros_ec_commands.h
include/linux/platform_data/cros_ec_commands.h:1092: warning: expecting
prototype for struct ec_response_get_cmd_version. Prototype was for
struct ec_response_get_cmd_versions instead
include/linux/platform_data/cros_ec_commands.h:5485: warning: This
comment starts with '/**', but isn't a kernel-doc comment.
include/linux/platform_data/cros_ec_commands.h:5496: warning: This
comment starts with '/**', but isn't a kernel-doc comment.

Signed-off-by: Tzung-Bi Shih <tzungbi@kernel.org>
---
 include/linux/platform_data/cros_ec_commands.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/include/linux/platform_data/cros_ec_commands.h b/include/linux/platform_data/cros_ec_commands.h
index 6665e7da6ee2..b9c4a3964247 100644
--- a/include/linux/platform_data/cros_ec_commands.h
+++ b/include/linux/platform_data/cros_ec_commands.h
@@ -1082,7 +1082,7 @@ struct ec_params_get_cmd_versions_v1 {
 } __ec_align2;
 
 /**
- * struct ec_response_get_cmd_version - Response to the get command versions.
+ * struct ec_response_get_cmd_versions - Response to the get command versions.
  * @version_mask: Mask of supported versions; use EC_VER_MASK() to compare with
  *                a desired version.
  */
@@ -5480,7 +5480,7 @@ struct ec_response_rollback_info {
 /* Issue AP reset */
 #define EC_CMD_AP_RESET 0x0125
 
-/**
+/*
  * Get the number of peripheral charge ports
  */
 #define EC_CMD_PCHG_COUNT 0x0134
@@ -5491,7 +5491,7 @@ struct ec_response_pchg_count {
 	uint8_t port_count;
 } __ec_align1;
 
-/**
+/*
  * Get the status of a peripheral charge port
  */
 #define EC_CMD_PCHG 0x0135
-- 
2.39.0.314.g84b9a713c41-goog


  parent reply	other threads:[~2023-01-11  5:57 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-01-11  5:57 [PATCH 0/4] platform/chrome: fix kernel-doc warnings Tzung-Bi Shih
2023-01-11  5:57 ` [PATCH 1/4] platform/chrome: fix kernel-doc warnings for panic notifier Tzung-Bi Shih
2023-01-11 16:30   ` Guenter Roeck
2023-01-11  5:57 ` [PATCH 2/4] platform/chrome: fix kernel-doc warning for suspend_timeout_ms Tzung-Bi Shih
2023-01-11 16:31   ` Guenter Roeck
2023-01-11  5:57 ` [PATCH 3/4] platform/chrome: fix kernel-doc warning for last_resume_result Tzung-Bi Shih
2023-01-11 16:31   ` Guenter Roeck
2023-01-11  5:57 ` Tzung-Bi Shih [this message]
2023-01-11 16:32   ` [PATCH 4/4] platform/chrome: fix kernel-doc warnings for cros_ec_command Guenter Roeck
2023-01-13 21:20 ` [PATCH 0/4] platform/chrome: fix kernel-doc warnings patchwork-bot+chrome-platform
2023-01-15 12:50 ` patchwork-bot+chrome-platform

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230111055728.708990-5-tzungbi@kernel.org \
    --to=tzungbi@kernel.org \
    --cc=bleung@chromium.org \
    --cc=chrome-platform@lists.linux.dev \
    --cc=groeck@chromium.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox