Skip to contentSkip to conversation

platform/chrome: cros_ec_debugfs: fix kernel-doc warning

PATCH Applied Tzung-Bi Shih 4 participants 6 messages Apr 11, 2023 – Apr 12, 2023

Subsystems (2)
lore
Share & tools
lore

Tzung-Bi Shih

author maintainer
#0 lore raw

PATCH 1/1 platform/chrome: cros_ec_debugfs: fix kernel-doc warning

Fix the following kernel-doc warning:

$ ./scripts/kernel-doc -none drivers/platform/chrome/*
[...]
warning: This comment starts with '/**', but isn't a kernel-doc comment.
Fixes 14bb09b32f43 ("platform/chrome: cros_ec: Separate logic for getting panic info")

---
I should put it in my checklist in the future before pushing patches to for-next.

 drivers/platform/chrome/cros_ec_debugfs.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/platform/chrome/cros_ec_debugfs.c +1 -1
index 414ebfffcf83..c876120e0ebc 100644
@@ -400,7 +400,7 @@ static void cros_ec_cleanup_console_log(struct cros_ec_debugfs *debug_info)
 	}
 }
 
-/**
+/*
  * Returns the size of the panicinfo data fetched from the EC
  */
 static int cros_ec_get_panicinfo(struct cros_ec_device *ec_dev, uint8_t *data,
Signature · 1 line
2.40.0.577.gac1e443424-goog
Reviewed-by on v1 1/1
#1 lore raw

Hi Tzung-Bi,

Quoted 9 lines · Tzung-Bi Shih

Fix the following kernel-doc warning:

$ ./scripts/kernel-doc -none drivers/platform/chrome/*
[...]
warning: This comment starts with '/**', but isn't a kernel-doc comment.
Fixes 14bb09b32f43 ("platform/chrome: cros_ec: Separate logic for getting panic info")
Quoted 24 lines

---
I should put it in my checklist in the future before pushing patches to for-next.

 drivers/platform/chrome/cros_ec_debugfs.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/platform/chrome/cros_ec_debugfs.c +1 -1
index 414ebfffcf83..c876120e0ebc 100644
@@ -400,7 +400,7 @@ static void cros_ec_cleanup_console_log(struct cros_ec_debugfs *debug_info)
 	}
 }
 
-/**
+/*
  * Returns the size of the panicinfo data fetched from the EC
  */
 static int cros_ec_get_panicinfo(struct cros_ec_device *ec_dev, uint8_t *data,
Signature · 1 line
2.40.0.577.gac1e443424-goog
Signature · 7 lines
Benson Leung
Staff Software Engineer
Chrome OS Kernel
Google Inc.
[email protected]
Chromium OS Project
[email protected]
#2 lore raw
In reply to Tzung-Bi Shih
This patch was applied to chrome-platform/linux.git (for-kernelci) by Tzung-Bi Shih <[email protected]>:

Hello:

This patch was applied to chrome-platform/linux.git (for-kernelci) by Tzung-Bi Shih <[email protected]>:

Quoted 11 lines · On Tue, 11 Apr 2023 13:33:08 +0800 you wrote:

Fix the following kernel-doc warning:

$ ./scripts/kernel-doc -none drivers/platform/chrome/*
[...]
warning: This comment starts with '/**', but isn't a kernel-doc comment.
Fixes 14bb09b32f43 ("platform/chrome: cros_ec: Separate logic for getting panic info")

[...]

Here is the summary with links:
- platform/chrome: cros_ec_debugfs: fix kernel-doc warning

    https://git.kernel.org/chrome-platform/c/419346a03810

You are awesome, thank you!

Signature · 2 lines
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html
#3 lore raw
In reply to Tzung-Bi Shih
Quoted 7 lines · Tzung-Bi Shih

Fix the following kernel-doc warning:

$ ./scripts/kernel-doc -none drivers/platform/chrome/*
[...]
warning: This comment starts with '/**', but isn't a kernel-doc comment.
Quoted 6 lines
Fixes 14bb09b32f43 ("platform/chrome: cros_ec: Separate logic for getting panic info")

---
I should put it in my checklist in the future before pushing patches to for-next.

Can this be added to kernelci?

Quoted 21 lines
 drivers/platform/chrome/cros_ec_debugfs.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/platform/chrome/cros_ec_debugfs.c +1 -2
index 414ebfffcf83..c876120e0ebc 100644
@@ -400,7 +400,7 @@ static void cros_ec_cleanup_console_log(struct cros_ec_debugfs *debug_info)
        }
 }
 
-/**
+/*
  * Returns the size of the panicinfo data fetched from the EC
  */
 static int cros_ec_get_panicinfo(struct cros_ec_device *ec_dev, uint8_t *data,
--

2.40.0.577.gac1e443424-goog

author maintainer
#4 lore raw
Quoted 8 lines · Prashant Malani
Quoted 7 lines · Tzung-Bi Shih

Fix the following kernel-doc warning:

$ ./scripts/kernel-doc -none drivers/platform/chrome/*
[...]
warning: This comment starts with '/**', but isn't a kernel-doc comment.
Quoted 8 lines
Quoted 6 lines
Fixes 14bb09b32f43 ("platform/chrome: cros_ec: Separate logic for getting panic info")

---
I should put it in my checklist in the future before pushing patches to for-next.

Can this be added to kernelci?

I'm afraid not; build tests performed by KernelCI only for its tests. 0-day performs better on such kind of static checks.

#5 lore raw
In reply to Tzung-Bi Shih
This patch was applied to chrome-platform/linux.git (for-next) by Tzung-Bi Shih <[email protected]>:

Hello:

This patch was applied to chrome-platform/linux.git (for-next) by Tzung-Bi Shih <[email protected]>:

Quoted 11 lines · On Tue, 11 Apr 2023 13:33:08 +0800 you wrote:

Fix the following kernel-doc warning:

$ ./scripts/kernel-doc -none drivers/platform/chrome/*
[...]
warning: This comment starts with '/**', but isn't a kernel-doc comment.
Fixes 14bb09b32f43 ("platform/chrome: cros_ec: Separate logic for getting panic info")

[...]

Here is the summary with links:
- platform/chrome: cros_ec_debugfs: fix kernel-doc warning

    https://git.kernel.org/chrome-platform/c/419346a03810

You are awesome, thank you!

Signature · 2 lines
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html