mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Julia Lawall <julia.lawall@inria.fr>
To: Maria Sheikh <mariasheikh812@gmail.com>
Cc: outreachy@lists.linux.dev, gregkh@linuxfoundation.org,
	 parthiban.veerasooran@microchip.com,
	christian.gromm@microchip.com,  linux-staging@lists.linux.dev,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH] staging: most: dim2: fix non-kernel-doc comment in errors.h
Date: Mon, 2 Nov 2026 09:05:59 +0100 (CET)	[thread overview]
Message-ID: <5ff5dc97-5a27-c68c-a4b2-959081941084@inria.fr> (raw)
In-Reply-To: <20261102022903.5312-1-mariasheikh812@gmail.com>



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
>
>
>

      reply	other threads:[~2026-11-02  8:06 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-02  2:28 Maria Sheikh
2026-11-02  8:05 ` Julia Lawall [this message]

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=5ff5dc97-5a27-c68c-a4b2-959081941084@inria.fr \
    --to=julia.lawall@inria.fr \
    --cc=christian.gromm@microchip.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-staging@lists.linux.dev \
    --cc=mariasheikh812@gmail.com \
    --cc=outreachy@lists.linux.dev \
    --cc=parthiban.veerasooran@microchip.com \
    /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

all inboxes | Powered by JetHome®