Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:1 as permitted sender) client-ip=2620:137:e000::3:1;
MIME-Version: 1.0
References: <20231206030523.302-1-rdunlap@infradead.org>
In-Reply-To: <20231206030523.302-1-rdunlap@infradead.org>
From:   Bartosz Golaszewski <brgl@bgdev.pl>
Date:   Thu, 7 Dec 2023 09:24:33 +0100
Message-ID: <CAMRc=MenMowQVw70XXpKW3F99Pu4T77FghvsUEPZxDGz6jMh1g@mail.gmail.com>
Subject: Re: [PATCH] gpio: max730x: don't use kernel-doc marker for regular comment
To:     Randy Dunlap <rdunlap@infradead.org>
Cc:     linux-kernel@vger.kernel.org,
        Linus Walleij <linus.walleij@linaro.org>,
        Andy Shevchenko <andy@kernel.org>, linux-gpio@vger.kernel.org
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
Precedence: bulk

On Wed, Dec 6, 2023 at 4:05=E2=80=AFAM Randy Dunlap <rdunlap@infradead.org>=
 wrote:
>
> Use a common C comment (/*) instead of kernel-doc notation to prevent
> warnings from scripts/kernel-doc.
>
> gpio-max730x.c:3: warning: This comment starts with '/**', but isn't a ke=
rnel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> gpio-max730x.c:3: warning: missing initial short description on line:
>  * Copyright (C) 2006 Juergen Beisert, Pengutronix
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
>  drivers/gpio/gpio-max730x.c |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff -- a/drivers/gpio/gpio-max730x.c b/drivers/gpio/gpio-max730x.c
> --- a/drivers/gpio/gpio-max730x.c
> +++ b/drivers/gpio/gpio-max730x.c
> @@ -1,5 +1,5 @@
>  // SPDX-License-Identifier: GPL-2.0-only
> -/**
> +/*
>   * Copyright (C) 2006 Juergen Beisert, Pengutronix
>   * Copyright (C) 2008 Guennadi Liakhovetski, Pengutronix
>   * Copyright (C) 2009 Wolfram Sang, Pengutronix

Applied, thanks!

Bart