* [PATCH] staging: most: dim2: fix non-kernel-doc comment in errors.h
@ 2026-11-02 2:28 Maria Sheikh
2026-11-02 8:05 ` Julia Lawall
0 siblings, 1 reply; 2+ messages in thread
From: Maria Sheikh @ 2026-11-02 2:28 UTC (permalink / raw)
To: outreachy, gregkh, parthiban.veerasooran, christian.gromm,
linux-staging, linux-kernel
Cc: Maria Sheikh
The comment above enum dim_errors_t starts with "/**" but it is not in
kernel-doc format, which scripts/kernel-doc -none reports as a warning.
Use a regular comment instead.
Found using scripts/kernel-doc -none
Signed-off-by: Maria Sheikh <mariasheikh812@gmail.com>
---
drivers/staging/most/dim2/errors.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/drivers/staging/most/dim2/errors.h b/drivers/staging/most/dim2/errors.h
index d707daaac3b6..af909560aa93 100644
--- a/drivers/staging/most/dim2/errors.h
+++ b/drivers/staging/most/dim2/errors.h
@@ -9,7 +9,7 @@
#ifndef _MOST_DIM_ERRORS_H
#define _MOST_DIM_ERRORS_H
-/**
+/*
* MOST DIM errors.
*/
enum dim_errors_t {
--
2.53.0
^ permalink raw reply [flat|nested] 2+ messages in thread* Re: [PATCH] staging: most: dim2: fix non-kernel-doc comment in errors.h
2026-11-02 2:28 [PATCH] staging: most: dim2: fix non-kernel-doc comment in errors.h Maria Sheikh
@ 2026-11-02 8:05 ` Julia Lawall
0 siblings, 0 replies; 2+ messages in thread
From: Julia Lawall @ 2026-11-02 8:05 UTC (permalink / raw)
To: Maria Sheikh
Cc: outreachy, gregkh, parthiban.veerasooran, christian.gromm,
linux-staging, linux-kernel
On Mon, 2 Nov 2026, Maria Sheikh wrote:
> The comment above enum dim_errors_t starts with "/**" but it is not in
> kernel-doc format, which scripts/kernel-doc -none reports as a warning.
> Use a regular comment instead.
>
> Found using scripts/kernel-doc -none
>
> Signed-off-by: Maria Sheikh <mariasheikh812@gmail.com>
> ---
> drivers/staging/most/dim2/errors.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/staging/most/dim2/errors.h b/drivers/staging/most/dim2/errors.h
> index d707daaac3b6..af909560aa93 100644
> --- a/drivers/staging/most/dim2/errors.h
> +++ b/drivers/staging/most/dim2/errors.h
> @@ -9,7 +9,7 @@
> #ifndef _MOST_DIM_ERRORS_H
> #define _MOST_DIM_ERRORS_H
>
> -/**
> +/*
> * MOST DIM errors.
> */
If it's going to be a regular comment it doesn't need to be on three
lines.
Maybe it could be made into a kerneldoc comment?
julia
> enum dim_errors_t {
> --
> 2.53.0
>
>
>
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2026-11-02 8:06 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2026-11-02 2:28 [PATCH] staging: most: dim2: fix non-kernel-doc comment in errors.h Maria Sheikh
2026-11-02 8:05 ` Julia Lawall
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®