1. Patchew
  2. linux
  3. View series

[PATCH v2] drm: Add directive to format code in comment

Javier Garcia posted 1 patch 1 month, 3 weeks ago
There is a newer version of this series
drivers/gpu/drm/drm_gpuvm.c | 2 ++
1 file changed, 2 insertions(+)
[PATCH v2] drm: Add directive to format code in comment
Posted by Javier Garcia 1 month, 3 weeks ago 
Fixes: 471920ce25d5 ("drm/gpuvm: Add locking helpers")

  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.


Signed-off-by: Javier Garcia <rampxxxx@gmail.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
Re: [PATCH v2] drm: Add directive to format code in comment
Posted by Danilo Krummrich 1 month, 3 weeks ago 
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.

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

[1] https://docs.kernel.org/process/submitting-patches.html#describe-your-changes

>
>
> Signed-off-by: Javier Garcia <rampxxxx@gmail.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
Re: [PATCH v2] drm: Add directive to format code in comment
Posted by Giant Sand Fans 1 month, 3 weeks ago 
On Sun, 10 Aug 2025 at 15:23, Danilo Krummrich <dakr@kernel.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@gmail.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
>
[PATCH v3] drm: Add directive to format code in comment
Posted by Javier Garcia 1 month, 3 weeks ago 
Add formating directive line in function `drm_gpuvm_sm_map_exec_lock()`
comment to clear warning messages shown bellow that appears generating
documentation `make htmldocs`.

  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.

Fixes: 471920ce25d5 ("drm/gpuvm: Add locking helpers")
Signed-off-by: Javier Garcia <rampxxxx@gmail.com>
---
v2 -> v3:
      * Added the proper imperative message.
      * Fixes tag possition.
      * v2 https://lore.kernel.org/lkml/20250810112218.293272-1-rampxxxx@gmail.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
Re: [PATCH v3] drm: Add directive to format code in comment
Posted by Danilo Krummrich 1 month, 2 weeks ago 
On 8/10/25 5:07 PM, Javier Garcia wrote:
> Add formating directive line in function `drm_gpuvm_sm_map_exec_lock()`
> comment to clear warning messages shown bellow that appears generating
> documentation `make htmldocs`.
> 
>    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.
> 
> Fixes: 471920ce25d5 ("drm/gpuvm: Add locking helpers")
> Signed-off-by: Javier Garcia <rampxxxx@gmail.com>

Applied to drm-misc-fixes, thanks!
Re: [PATCH v3] drm: Add directive to format code in comment
Posted by Bagas Sanjaya 1 month, 3 weeks ago 
On Sun, Aug 10, 2025 at 05:07:06PM +0200, Javier Garcia wrote:
>   * The expected usage is:
>   *
> + * .. code-block:: c
> + *
>   *    vm_bind {
>   *        struct drm_exec exec;
>   *

LGTM, thanks!

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>

-- 
An old man doll... just what I always wanted! - Clara

Patchew 2.1-devel-b67e4c2

© 2016 - 2025 Red Hat, Inc.