diff mbox series

drm/print: cleanup coding style in drm_print.h

Message ID 20220904203818.16775-1-jingyuwang_vip@163.com (mailing list archive)
State New, archived
Headers show
Series drm/print: cleanup coding style in drm_print.h | expand

Commit Message

Jingyu Wang Sept. 4, 2022, 8:38 p.m. UTC
Fix everything checkpatch.pl complained about in drm_print.h

Signed-off-by: Jingyu Wang <jingyuwang_vip@163.com>
---
 include/drm/drm_print.h | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)


base-commit: e47eb90a0a9ae20b82635b9b99a8d0979b757ad8
prerequisite-patch-id: f039528bc88876d6e0f64e843da089e85f6d3f58
prerequisite-patch-id: c14ed2e970be2c3f8ba746634e8161b94c148e88

Comments

Jani Nikula Sept. 5, 2022, 8:45 a.m. UTC | #1
On Mon, 05 Sep 2022, Jingyu Wang <jingyuwang_vip@163.com> wrote:
> Fix everything checkpatch.pl complained about in drm_print.h

Sorry, you just can't assume the checkpatch.pl complaints are all
correct, or that it would be this trivial to fix them.

This is broken.

> Signed-off-by: Jingyu Wang <jingyuwang_vip@163.com>
> ---
>  include/drm/drm_print.h | 11 ++++++-----
>  1 file changed, 6 insertions(+), 5 deletions(-)
>
> diff --git a/include/drm/drm_print.h b/include/drm/drm_print.h
> index 22fabdeed297..4332fbeb76a8 100644
> --- a/include/drm/drm_print.h
> +++ b/include/drm/drm_print.h
> @@ -1,3 +1,4 @@
> +/* SPDX-License-Identifier: MIT */

What's the point of having both the SPDX and full license text in the
header? But unless you're the license holder, I'd be pretty careful
about removing the license text.

>  /*
>   * Copyright (C) 2016 Red Hat
>   *
> @@ -103,7 +104,7 @@ __printf(2, 0)
>   * @va: the va_list
>   */
>  static inline void
> -drm_vprintf(struct drm_printer *p, const char *fmt, va_list *va)
> +drm_vprintf(struct drm_printer *p, const char *fmt, va_list * va)

Checkpatch is just confused here. Look at all the other params, why
would you add an extra space here?

>  {
>  	struct va_format vaf = { .fmt = fmt, .va = va };
>  
> @@ -426,16 +427,16 @@ void drm_dev_dbg(const struct device *dev, enum drm_debug_category category,
>  
>  
>  #define drm_info(drm, fmt, ...)					\
> -	__drm_printk((drm), info,, fmt, ##__VA_ARGS__)
> +	__drm_printk((drm), info, fmt, ##__VA_ARGS__)
>  
>  #define drm_notice(drm, fmt, ...)				\
> -	__drm_printk((drm), notice,, fmt, ##__VA_ARGS__)
> +	__drm_printk((drm), notice, fmt, ##__VA_ARGS__)
>  
>  #define drm_warn(drm, fmt, ...)					\
> -	__drm_printk((drm), warn,, fmt, ##__VA_ARGS__)
> +	__drm_printk((drm), warn, fmt, ##__VA_ARGS__)
>  
>  #define drm_err(drm, fmt, ...)					\
> -	__drm_printk((drm), err,, "*ERROR* " fmt, ##__VA_ARGS__)
> +	__drm_printk((drm), err, "*ERROR* " fmt, ##__VA_ARGS__)

This is macro magic, and that ,, there passes an empty arg. You remove
it completely, shifting all the args to the wrong place, breaking drm
error logging.

BR,
Jani.

>  
>  
>  #define drm_info_once(drm, fmt, ...)				\
>
> base-commit: e47eb90a0a9ae20b82635b9b99a8d0979b757ad8
> prerequisite-patch-id: f039528bc88876d6e0f64e843da089e85f6d3f58
> prerequisite-patch-id: c14ed2e970be2c3f8ba746634e8161b94c148e88
Jani Nikula Sept. 5, 2022, 8:49 a.m. UTC | #2
On Mon, 05 Sep 2022, Jani Nikula <jani.nikula@linux.intel.com> wrote:
> On Mon, 05 Sep 2022, Jingyu Wang <jingyuwang_vip@163.com> wrote:
>> Fix everything checkpatch.pl complained about in drm_print.h

[...]

>>  static inline void
>> -drm_vprintf(struct drm_printer *p, const char *fmt, va_list *va)
>> +drm_vprintf(struct drm_printer *p, const char *fmt, va_list * va)
>
> Checkpatch is just confused here. Look at all the other params, why
> would you add an extra space here?

Joe, can you help me out here please, I can't figure out why checkpatch
is complaining here:

include/drm/drm_print.h:106: CHECK:SPACING: spaces preferred around that '*' (ctx:WxV)
#106: FILE: include/drm/drm_print.h:106:
+drm_vprintf(struct drm_printer *p, const char *fmt, va_list *va)


BR,
Jani.
Joe Perches Sept. 5, 2022, 10:05 a.m. UTC | #3
On Mon, 2022-09-05 at 11:49 +0300, Jani Nikula wrote:
> On Mon, 05 Sep 2022, Jani Nikula <jani.nikula@linux.intel.com> wrote:
> > On Mon, 05 Sep 2022, Jingyu Wang <jingyuwang_vip@163.com> wrote:
> > > Fix everything checkpatch.pl complained about in drm_print.h
> 
> [...]
> 
> > >  static inline void
> > > -drm_vprintf(struct drm_printer *p, const char *fmt, va_list *va)
> > > +drm_vprintf(struct drm_printer *p, const char *fmt, va_list * va)
> > 
> > Checkpatch is just confused here. Look at all the other params, why
> > would you add an extra space here?
> 
> Joe, can you help me out here please, I can't figure out why checkpatch
> is complaining here:
> 
> include/drm/drm_print.h:106: CHECK:SPACING: spaces preferred around that '*' (ctx:WxV)
> #106: FILE: include/drm/drm_print.h:106:
> +drm_vprintf(struct drm_printer *p, const char *fmt, va_list *va)

checkpatch doesn't know what a va_list is.

It's similar to the FILE typedef that also causes this output.

A recent link to add an exception for 'FILE' to checkpatch:

https://lore.kernel.org/all/20220902111923.1488671-1-mic@digikod.net/
diff mbox series

Patch

diff --git a/include/drm/drm_print.h b/include/drm/drm_print.h
index 22fabdeed297..4332fbeb76a8 100644
--- a/include/drm/drm_print.h
+++ b/include/drm/drm_print.h
@@ -1,3 +1,4 @@ 
+/* SPDX-License-Identifier: MIT */
 /*
  * Copyright (C) 2016 Red Hat
  *
@@ -103,7 +104,7 @@  __printf(2, 0)
  * @va: the va_list
  */
 static inline void
-drm_vprintf(struct drm_printer *p, const char *fmt, va_list *va)
+drm_vprintf(struct drm_printer *p, const char *fmt, va_list * va)
 {
 	struct va_format vaf = { .fmt = fmt, .va = va };
 
@@ -426,16 +427,16 @@  void drm_dev_dbg(const struct device *dev, enum drm_debug_category category,
 
 
 #define drm_info(drm, fmt, ...)					\
-	__drm_printk((drm), info,, fmt, ##__VA_ARGS__)
+	__drm_printk((drm), info, fmt, ##__VA_ARGS__)
 
 #define drm_notice(drm, fmt, ...)				\
-	__drm_printk((drm), notice,, fmt, ##__VA_ARGS__)
+	__drm_printk((drm), notice, fmt, ##__VA_ARGS__)
 
 #define drm_warn(drm, fmt, ...)					\
-	__drm_printk((drm), warn,, fmt, ##__VA_ARGS__)
+	__drm_printk((drm), warn, fmt, ##__VA_ARGS__)
 
 #define drm_err(drm, fmt, ...)					\
-	__drm_printk((drm), err,, "*ERROR* " fmt, ##__VA_ARGS__)
+	__drm_printk((drm), err, "*ERROR* " fmt, ##__VA_ARGS__)
 
 
 #define drm_info_once(drm, fmt, ...)				\