Skip to contentSkip to conversation

staging: iio: adc: Add comments to prevent checks corrections

PATCH In review Gabriel Capella 4 participants 4 messages Oct 15, 2018 – Oct 16, 2018

Subsystems (4)
Staging IIO Analog Devices IIO drivers Staging - industrial io
lore
Share & tools
lore

Gabriel Capella

author
#0 lore raw

PATCH 1/1 staging: iio: adc: Add comments to prevent checks corrections

This patch adds 3 comments in 2 different files. These comments warn to don't correct the checks of type:
"CHECK: spaces preferred around that '-'"

Signed-off-by Gabriel Capella <[email protected]>
---
 drivers/staging/iio/adc/ad7192.c  | 1 +
 drivers/staging/iio/adc/ad7280a.c | 2 ++
 2 files changed, 3 insertions(+)
drivers/staging/iio/adc/ad7192.c +1 -0
index acdbc07fd259..786ace19c240 100644
@@ -354,6 +354,7 @@ ad7192_show_scale_available(struct device *dev,
 	return len;
 }
 
+/* Do not put spaces around the hyphen. #checkpatch.pl */
 static IIO_DEVICE_ATTR_NAMED(in_v_m_v_scale_available,
 			     in_voltage-voltage_scale_available,
 			     0444, ad7192_show_scale_available, NULL, 0);
drivers/staging/iio/adc/ad7280a.c +2 -0
index 58420dcb406d..4927116a046c 100644
@@ -749,6 +749,7 @@ static irqreturn_t ad7280_event_handler(int irq, void *private)
 	return IRQ_HANDLED;
 }
 
+/* Do not put spaces around the hyphen. #checkpatch.pl */
 static IIO_DEVICE_ATTR_NAMED(in_thresh_low_value,
 		in_voltage-voltage_thresh_low_value,
 		0644,

@@ -756,6 +757,7 @@ static IIO_DEVICE_ATTR_NAMED(in_thresh_low_value,
 		ad7280_write_channel_config,
 		AD7280A_CELL_UNDERVOLTAGE);
 
+/* Do not put spaces around the hyphen. #checkpatch.pl */
 static IIO_DEVICE_ATTR_NAMED(in_thresh_high_value,
 		in_voltage-voltage_thresh_high_value,
 		0644,

--

#1 lore raw
Quoted 15 lines · Gabriel Capella

This patch adds 3 comments in 2 different files. These comments warn to don't correct the checks of type:
"CHECK: spaces preferred around that '-'"

Signed-off-by Gabriel Capella <[email protected]>
---
 drivers/staging/iio/adc/ad7192.c  | 1 +
 drivers/staging/iio/adc/ad7280a.c | 2 ++
 2 files changed, 3 insertions(+)
drivers/staging/iio/adc/ad7192.c +0 -0
index acdbc07fd259..786ace19c240 100644

drivers/staging/iio/adc/ad7192.c ad7192_show_scale_available(struct device *dev, · line 360

Quoted 7 lines
drivers/staging/iio/adc/ad7192.c +1 -0
@@ -354,6 +354,7 @@ ad7192_show_scale_available(struct device *dev,
 	return len;
 }
 
+/* Do not put spaces around the hyphen. #checkpatch.pl */
 static IIO_DEVICE_ATTR_NAMED(in_v_m_v_scale_available,
 			     in_voltage-voltage_scale_available,
 			     0444, ad7192_show_scale_available, NULL, 0);

No one will read that... :( It has to be on the same line.

regards,
dan carpenter

#2 lore raw
In reply to Gabriel Capella
Quoted 9 lines · Gabriel Capella

This patch adds 3 comments in 2 different files. These comments warn to don't correct the checks of type:
"CHECK: spaces preferred around that '-'"

Signed-off-by Gabriel Capella <[email protected]>
---
 drivers/staging/iio/adc/ad7192.c  | 1 +
 drivers/staging/iio/adc/ad7280a.c | 2 ++
 2 files changed, 3 insertions(+)

I have this simpler solution...let's focus our efforts on moving the two drivers out of staging. This will prevent the CHK to appear:

Cut from checkpatch.pl:

if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
	$check = 1;

Existing driver out of staging, with this "problem":

$ ./scripts/checkpatch.pl --types SPACING --file drivers/iio/adc/ad7793.c        
total: 0 errors, 0 warnings, 827 lines checked

drivers/iio/adc/ad7793.c has no obvious style problems and is ready for submission.

NOTE: Used message types: SPACING

In my opinion it would stop this incorrect patches.

I have also this changes to checkpatch.pl:
https://github.com/s-stepien/linux-1/commit/c976a31b392393fb417f2d9e2ec9639bc226ad0b
and usage:
https://github.com/s-stepien/linux-1/commit/1adc0428b496f44f6a931637084bb619ddd9992d
but I'm not that sure it is the best way to go.

What do you all think?

Signature · 1 line
Slawomir Stepien
#3 lore raw
Quoted 29 lines · Slawomir Stepien
Quoted 9 lines · Gabriel Capella

This patch adds 3 comments in 2 different files. These comments warn to don't correct the checks of type:
"CHECK: spaces preferred around that '-'"

Signed-off-by Gabriel Capella <[email protected]>
---
 drivers/staging/iio/adc/ad7192.c  | 1 +
 drivers/staging/iio/adc/ad7280a.c | 2 ++
 2 files changed, 3 insertions(+)

I have this simpler solution...let's focus our efforts on moving the two drivers out of staging. This will prevent the CHK to appear:

Cut from checkpatch.pl:

if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
	$check = 1;

Existing driver out of staging, with this "problem":

$ ./scripts/checkpatch.pl --types SPACING --file drivers/iio/adc/ad7793.c        
total: 0 errors, 0 warnings, 827 lines checked

drivers/iio/adc/ad7793.c has no obvious style problems and is ready for submission.

NOTE: Used message types: SPACING

In my opinion it would stop this incorrect patches. -

Quoted 7 lines

I have also this changes to checkpatch.pl:
https://github.com/s-stepien/linux-1/commit/c976a31b392393fb417f2d9e2ec9639bc226ad0b
and usage:
https://github.com/s-stepien/linux-1/commit/1adc0428b496f44f6a931637084bb619ddd9992d
but I'm not that sure it is the best way to go.

What do you all think?

I think the suggested form is somewhat cryptic

	/* checkpatch-<foo> */

and the new checkpatch code is somewhat balky.

It also allows only a single type to ignore per line.