| Message ID | 20230111055728.708990-5-tzungbi@kernel.org (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 5fa1dd818fb4b30cd2de42696de547e243d946d6 |
| Headers | show |
| Series | platform/chrome: fix kernel-doc warnings | expand |
On Tue, Jan 10, 2023 at 9:58 PM Tzung-Bi Shih <tzungbi@kernel.org> wrote: > > 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> Reviewed-by: Guenter Roeck <groeck@chromium.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 >
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
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(-)