[PATCH] platform/chrome: cros_ec_debugfs: fix kernel-doc warning

[PATCH] platform/chrome: cros_ec_debugfs: fix kernel-doc warning

[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")
Reported-by: kernel test robot <lkp@intel.com>
Signed-off-by: Tzung-Bi Shih <tzungbi@kernel.org>
---
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(-)

diff --git a/drivers/platform/chrome/cros_ec_debugfs.c b/drivers/platform/chrome/cros_ec_debugfs.c
index 414ebfffcf83..c876120e0ebc 100644
--- a/drivers/platform/chrome/cros_ec_debugfs.c
+++ b/drivers/platform/chrome/cros_ec_debugfs.c
@@ -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

Re: [PATCH] platform/chrome: cros_ec_debugfs: fix kernel-doc warning

[Benson Leung]

[-- Attachment #1: Type: text/plain, Size: 1445 bytes --]

Hi Tzung-Bi,

On Tue, Apr 11, 2023 at 01:33:08PM +0800, Tzung-Bi Shih 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")
> Reported-by: kernel test robot <lkp@intel.com>
> Signed-off-by: Tzung-Bi Shih <tzungbi@kernel.org>

Reviewed-by: Benson Leung <bleung@chromium.org>

> ---
> 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(-)
> 
> diff --git a/drivers/platform/chrome/cros_ec_debugfs.c b/drivers/platform/chrome/cros_ec_debugfs.c
> index 414ebfffcf83..c876120e0ebc 100644
> --- a/drivers/platform/chrome/cros_ec_debugfs.c
> +++ b/drivers/platform/chrome/cros_ec_debugfs.c
> @@ -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
> 
> 

-- 
Benson Leung
Staff Software Engineer
Chrome OS Kernel
Google Inc.
bleung@google.com
Chromium OS Project
bleung@chromium.org

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH] platform/chrome: cros_ec_debugfs: fix kernel-doc warning

[patchwork-bot+chrome-platform]

Hello:

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

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")
> Reported-by: kernel test robot <lkp@intel.com>
> Signed-off-by: Tzung-Bi Shih <tzungbi@kernel.org>
> 
> [...]

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!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html

Re: [PATCH] platform/chrome: cros_ec_debugfs: fix kernel-doc warning

[Prashant Malani]

On Mon, Apr 10, 2023 at 10:33 PM Tzung-Bi Shih <tzungbi@kernel.org> 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")
> Reported-by: kernel test robot <lkp@intel.com>
> Signed-off-by: Tzung-Bi Shih <tzungbi@kernel.org>
> ---
> I should put it in my checklist in the future before pushing patches to
> for-next.

Can this be added to kernelci?

>
>  drivers/platform/chrome/cros_ec_debugfs.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/platform/chrome/cros_ec_debugfs.c b/drivers/platform/chrome/cros_ec_debugfs.c
> index 414ebfffcf83..c876120e0ebc 100644
> --- a/drivers/platform/chrome/cros_ec_debugfs.c
> +++ b/drivers/platform/chrome/cros_ec_debugfs.c
> @@ -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
>
>

Re: [PATCH] platform/chrome: cros_ec_debugfs: fix kernel-doc warning

[patchwork-bot+chrome-platform]

Hello:

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

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")
> Reported-by: kernel test robot <lkp@intel.com>
> Signed-off-by: Tzung-Bi Shih <tzungbi@kernel.org>
> 
> [...]

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!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html

Re: [PATCH] platform/chrome: cros_ec_debugfs: fix kernel-doc warning

[Tzung-Bi Shih]

On Tue, Apr 11, 2023 at 10:38:15AM -0700, Prashant Malani wrote:
> On Mon, Apr 10, 2023 at 10:33 PM Tzung-Bi Shih <tzungbi@kernel.org> 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")
> > Reported-by: kernel test robot <lkp@intel.com>
> > Signed-off-by: Tzung-Bi Shih <tzungbi@kernel.org>
> > ---
> > 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.