linux-kernel - Re: [PATCH v2] drm: Add directive to format code in comment

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <CABPJ0vjjVUTYpWbV6LLY0nsPuZze0hcBiBOczox4Mk7LJsKtUg@mail.gmail.com>
Date: Sun, 10 Aug 2025 16:12:54 +0200
From: Giant Sand Fans <rampxxxx@...il.com>
To: Danilo Krummrich <dakr@...nel.org>
Cc: maarten.lankhorst@...ux.intel.com, mripard@...nel.org, tzimmermann@...e.de, 
	airlied@...il.com, simona@...ll.ch, robin.clark@....qualcomm.com, 
	antomani103@...il.com, dmitry.baryshkov@....qualcomm.com, 
	me@...ghamcampbell.com, dri-devel@...ts.freedesktop.org, 
	linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2] drm: Add directive to format code in comment

On Sun, 10 Aug 2025 at 15:23, Danilo Krummrich <dakr@...nel.org> wrote:
>
> Hi Javier,
>
> On Sun Aug 10, 2025 at 1:22 PM CEST, Javier Garcia wrote:
>
> Thanks for the patch.
>
> > Fixes: 471920ce25d5 ("drm/gpuvm: Add locking helpers")
>
> The Fixes: tag belongs at the end of the commit message, like all other tags.

Thanks

>
> >   Warning: ./drivers/gpu/drm/drm_gpuvm.c:2444: Unexpected indentation.
> >   Warning: ./drivers/gpu/drm/drm_gpuvm.c:2446: Block quote ends without a blank line; unexpected unindent.
> >   Warning: ./drivers/gpu/drm/drm_gpuvm.c:2450: Definition list ends without a blank line; unexpected unindent.
> >   Warning: ./drivers/gpu/drm/drm_gpuvm.c:2451: Definition list ends without a blank line; unexpected unindent.
> >   Warning: ./drivers/gpu/drm/drm_gpuvm.c:2455: Unexpected indentation.
> >   Warning: ./drivers/gpu/drm/drm_gpuvm.c:2456: Definition list ends without a blank line; unexpected unindent.
> >   Warning: ./drivers/gpu/drm/drm_gpuvm.c:2457: Definition list ends without a blank line; unexpected unindent.
> >   Warning: ./drivers/gpu/drm/drm_gpuvm.c:2458: Definition list ends without a blank line; unexpected unindent.
>
> Even though it's rather obvious in this case, the commit message should contain
> the motivation of the patch and how it addresses the issue in imperative mood,
> see also [1].

Thanks

>
> [1] https://docs.kernel.org/process/submitting-patches.html#describe-your-changes
>
> >
> >
> > Signed-off-by: Javier Garcia <rampxxxx@...il.com>
> > ---
> > v1 -> v2:
> >       * Added the proper Fixes tag.
> >       * v1 https://lore.kernel.org/lkml/20250804212902.22554-1-rampxxxx@gmail.com
> >
> >  drivers/gpu/drm/drm_gpuvm.c | 2 ++
> >  1 file changed, 2 insertions(+)
> >
> > diff --git a/drivers/gpu/drm/drm_gpuvm.c b/drivers/gpu/drm/drm_gpuvm.c
> > index bbc7fecb6f4a..74d949995a72 100644
> > --- a/drivers/gpu/drm/drm_gpuvm.c
> > +++ b/drivers/gpu/drm/drm_gpuvm.c
> > @@ -2432,6 +2432,8 @@ static const struct drm_gpuvm_ops lock_ops = {
> >   *
> >   * The expected usage is:
> >   *
> > + * .. code-block:: c
> > + *
> >   *    vm_bind {
> >   *        struct drm_exec exec;
> >   *
> > --
> > 2.50.1
>