Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
From:   Felipe Balbi <balbi@kernel.org>
To:     Aditya Srivastava <yashsri421@gmail.com>
Cc:     yashsri421@gmail.com, lukas.bulwahn@gmail.com,
        rdunlap@infradead.org, gregkh@linuxfoundation.org,
        linux-kernel-mentees@lists.linuxfoundation.org,
        linux-doc@vger.kernel.org, linux-usb@vger.kernel.org,
        linux-kernel@vger.kernel.org
Subject: Re: [PATCH] USB: gadget: udc: fix kernel-doc syntax in file headers
In-Reply-To: <20210522115227.9977-1-yashsri421@gmail.com>
References: <20210522115227.9977-1-yashsri421@gmail.com>
Date:   Thu, 03 Jun 2021 17:33:13 +0300
Message-ID: <87czt3c91y.fsf@kernel.org>
MIME-Version: 1.0
Content-Type: multipart/signed; boundary="=-=-=";
        micalg=pgp-sha256; protocol="application/pgp-signature"
Precedence: bulk

--=-=-=
Content-Type: text/plain
Content-Transfer-Encoding: quoted-printable

Aditya Srivastava <yashsri421@gmail.com> writes:

> The opening comment mark '/**' is used for highlighting the beginning of
> kernel-doc comments.
> The header for drivers/usb/gadget/udc/trace files follows this syntax, but
> the content inside does not comply with kernel-doc.
>
> This line was probably not meant for kernel-doc parsing, but is parsed
> due to the presence of kernel-doc like comment syntax(i.e, '/**'), which
> causes unexpected warning from kernel-doc.
> For e.g., running scripts/kernel-doc -none drivers/usb/gadget/udc/trace.h
> emits:
> warning: expecting prototype for udc.c(). Prototype was for TRACE_SYSTEM(=
) instead
>
> Provide a simple fix by replacing this occurrence with general comment
> format, i.e. '/*', to prevent kernel-doc from parsing it.
>
> Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>

Acked-by: Felipe Balbi <balbi@kernel.org>

=2D-=20
balbi

--=-=-=
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iQFFBAEBCAAvFiEE9DumQ60WEZ09LIErzlfNM9wDzUgFAmC46CkRHGJhbGJpQGtl
cm5lbC5vcmcACgkQzlfNM9wDzUifDwgAtnFMd2i8Hm17HXt+UzjKTpBWvV88ADMj
uimkyjbm0+77YJUzI+viw9vludqI6MrQF1/IuPgTZ29XV8ddjv5OdGytFkuwJy4J
CvzgSFYcwLbIfN5XqqPxbnJfBW1+XpADGwcgcwUeyC86I7TaJu/8j/wl6ioE8NYd
h/kmY5UEZslh+0I0m/wRmis8Lhf1xJM4zr7uUGdNhgqSOq2b4cXeZGObxJww1/Rp
Ij0f6oVi6QtjPSaMr+pmqXrffP2Gk2WpFoNunEIbeEBiyifAaTRaAxf2ya9mC7Do
OvliCxol/kn35vvnXRON2o5NP0rtcsF0VCkMgLKPaJ/bqVtMADbiIg==
=8Y62
-----END PGP SIGNATURE-----
--=-=-=--