Skip to contentSkip to conversation

checkpatch: ignore CamelCase for inttypes.h format specifiers

PATCH In review Scott Branden 2 participants 7 messages Jun 10, 2020 – Jun 11, 2020 Checkpatch

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 checkpatch: ignore CamelCase for inttypes.h format specifiers

Ignore CamelCase for inttypes.h for fixed integer types format specifiers. (ex. PRIx32 for uint32_t).

---
 scripts/checkpatch.pl | 2 ++
 1 file changed, 2 insertions(+)
scripts/checkpatch.pl +2 -0
index 899e380782c0..9fa90457b270 100755
@@ -5157,6 +5157,8 @@ sub process {
 			    $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
 #Ignore Page<foo> variants
 			    $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
+#Ignore inttypes.h scanf/printf format specifiers for fixed size integer types
+			    $var !~ /^(?:PRI|SCN)[dxoui](8|16|32|64|PTR|MAX)?$/ &&
 #Ignore SI style variants like nS, mV and dB
 #(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
 			    $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ &&
Signature · 1 line
2.17.1
maintainer
#1 lore raw
Quoted 2 lines · Scott Branden

Ignore CamelCase for inttypes.h for fixed integer types format specifiers. (ex. PRIx32 for uint32_t).

Personally, I don't like those.

Quoted 18 lines
---
 scripts/checkpatch.pl | 2 ++
 1 file changed, 2 insertions(+)
scripts/checkpatch.pl +2 -0
index 899e380782c0..9fa90457b270 100755
@@ -5157,6 +5157,8 @@ sub process {
 			    $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
 #Ignore Page<foo> variants
 			    $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
+#Ignore inttypes.h scanf/printf format specifiers for fixed size integer types
+			    $var !~ /^(?:PRI|SCN)[dxoui](8|16|32|64|PTR|MAX)?$/ &&
 #Ignore SI style variants like nS, mV and dB
 #(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
 			    $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ &&
#2 lore raw
Quoted 4 lines · Joe Perches
Quoted 2 lines · Scott Branden

Ignore CamelCase for inttypes.h for fixed integer types format specifiers. (ex. PRIx32 for uint32_t).

Personally, I don't like those.

Checkpatch is run against a lot of code outside of the linux kernel but following linux coding style. There is nothing personal about this, they are the format specifiers in inttypes.h for fixed width types .

Quoted 19 lines
Quoted 19 lines
---
  scripts/checkpatch.pl | 2 ++
  1 file changed, 2 insertions(+)
scripts/checkpatch.pl +2 -0
index 899e380782c0..9fa90457b270 100755
@@ -5157,6 +5157,8 @@ sub process {
  			    $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
  #Ignore Page<foo> variants
  			    $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
+#Ignore inttypes.h scanf/printf format specifiers for fixed size integer types
+			    $var !~ /^(?:PRI|SCN)[dxoui](8|16|32|64|PTR|MAX)?$/ &&
  #Ignore SI style variants like nS, mV and dB
  #(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
  			    $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ &&
maintainer
#3 lore raw
Quoted 8 lines · Scott Branden
Quoted 4 lines · Joe Perches
Quoted 2 lines · Scott Branden

Ignore CamelCase for inttypes.h for fixed integer types format specifiers. (ex. PRIx32 for uint32_t).

Personally, I don't like those.

Checkpatch is run against a lot of code outside of the linux kernel but following linux coding style.

I know. I don't have any strong feeling about this either.

But _this_ checkpatch is specifically for the linux-kernel.

I just don't want to encourage a bunch of uses of these somewhat useless defines internal to linux-kernel sources.

Quoted 2 lines

There is nothing personal about this, they are the format specifiers in inttypes.h for fixed width types .

True. It's impersonal to me too.

Quoted 1 line
Quoted 1 line

scripts/checkpatch.pl

Quoted 1 line
scripts/checkpatch.pl +0 -0

[]

Quoted 6 lines
Quoted 6 lines

scripts/checkpatch.pl sub process { · line 5161

Quoted 6 lines
scripts/checkpatch.pl +2 -0
@@ -5157,6 +5157,8 @@ sub process {
  			    $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
  #Ignore Page<foo> variants
  			    $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
+#Ignore inttypes.h scanf/printf format specifiers for fixed size integer types
+			    $var !~ /^(?:PRI|SCN)[dxoui](8|16|32|64|PTR|MAX)?$/ &&

There are missing format specifiers.
If this is done, the test should be against a variable

Something like:

our $inttype_format = qr{(?x:

		(?:PRI|SCN)
		[diouxX]
		(?:FAST|LEAST)?
		(?:8|16|32|64|MAX|PTR)
};

btw: what about 24, 48, 96, 128 and 256?

Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
scripts/checkpatch.pl +0 -0
  #Ignore SI style variants like nS, mV and dB
  #(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
  			    $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ &&
#4 lore raw

Hi Joe,

Quoted 6 lines · Joe Perches
Quoted 5 lines · Scott Branden
Quoted 4 lines · Joe Perches
Quoted 2 lines · Scott Branden

Ignore CamelCase for inttypes.h for fixed integer types format specifiers. (ex. PRIx32 for uint32_t).

Personally, I don't like those.

Quoted 8 lines
Quoted 2 lines

Checkpatch is run against a lot of code outside of the linux kernel but following linux coding style.

I know. I don't have any strong feeling about this either.

But _this_ checkpatch is specifically for the linux-kernel.

I just don't want to encourage a bunch of uses of these somewhat useless defines internal to linux-kernel sources.

It is already used in various code in the linux-kernel tree for tools to work properly on different cpu architectures. Use of inttypes.h does have its place.
So _this_ checkpatch shouldn't be complaining about them in the linux repo either?

Quoted 29 lines
Quoted 2 lines

There is nothing personal about this, they are the format specifiers in inttypes.h for fixed width types .

True. It's impersonal to me too.

Quoted 1 line
Quoted 1 line

scripts/checkpatch.pl

Quoted 1 line
scripts/checkpatch.pl +0 -0

[]

Quoted 6 lines
Quoted 6 lines

scripts/checkpatch.pl sub process { · line 5161

Quoted 6 lines
scripts/checkpatch.pl +2 -0
@@ -5157,6 +5157,8 @@ sub process {
   			    $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
   #Ignore Page<foo> variants
   			    $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
+#Ignore inttypes.h scanf/printf format specifiers for fixed size integer types
+			    $var !~ /^(?:PRI|SCN)[dxoui](8|16|32|64|PTR|MAX)?$/ &&

There are missing format specifiers.
If this is done, the test should be against a variable

Something like:

our $inttype_format = qr{(?x:

		(?:PRI|SCN)
		[diouxX]
		(?:FAST|LEAST)?
		(?:8|16|32|64|MAX|PTR)
};

btw: what about 24, 48, 96, 128 and 256?

Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
scripts/checkpatch.pl +0 -0
   #Ignore SI style variants like nS, mV and dB
   #(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
   			    $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ &&
#5 lore raw
In reply to Joe Perches

Hi Joe,

A few questions about changes below.

Quoted 30 lines · Joe Perches
Quoted 7 lines · Scott Branden
Quoted 4 lines · Joe Perches
Quoted 2 lines · Scott Branden

Ignore CamelCase for inttypes.h for fixed integer types format specifiers. (ex. PRIx32 for uint32_t).

Personally, I don't like those.

Checkpatch is run against a lot of code outside of the linux kernel but following linux coding style.

I know. I don't have any strong feeling about this either.

But _this_ checkpatch is specifically for the linux-kernel.

I just don't want to encourage a bunch of uses of these somewhat useless defines internal to linux-kernel sources.

Quoted 2 lines

There is nothing personal about this, they are the format specifiers in inttypes.h for fixed width types .

True. It's impersonal to me too.

Quoted 1 line
Quoted 1 line

scripts/checkpatch.pl

Quoted 1 line
scripts/checkpatch.pl +0 -0

[]

Quoted 6 lines
Quoted 6 lines

scripts/checkpatch.pl sub process { · line 5161

Quoted 6 lines
scripts/checkpatch.pl +2 -0
@@ -5157,6 +5157,8 @@ sub process {
   			    $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
   #Ignore Page<foo> variants
   			    $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
+#Ignore inttypes.h scanf/printf format specifiers for fixed size integer types
+			    $var !~ /^(?:PRI|SCN)[dxoui](8|16|32|64|PTR|MAX)?$/ &&

There are missing format specifiers.
If this is done, the test should be against a variable

Quoted 8 lines

Something like:

our $inttype_format = qr{(?x:

		(?:PRI|SCN)
		[diouxX]
		(?:FAST|LEAST)?
		(?:8|16|32|64|MAX|PTR)
};

I can try adding the "X" and FAST|LEAST.
But I am not familiar enough with perl or the checkpatch script to understand what you mean by test should be against a variable vs what I have done.

Quoted 1 line

btw: what about 24, 48, 96, 128 and 256?

I can't find those values described for inttypes.h format specifiers. Where are you looking at those values from?

Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
scripts/checkpatch.pl +0 -0
   #Ignore SI style variants like nS, mV and dB
   #(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
   			    $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ &&
maintainer
#6 lore raw
Quoted 43 lines · Scott Branden

Hi Joe,

A few questions about changes below.

Quoted 30 lines · Joe Perches
Quoted 7 lines · Scott Branden
Quoted 4 lines · Joe Perches
Quoted 2 lines · Scott Branden

Ignore CamelCase for inttypes.h for fixed integer types format specifiers. (ex. PRIx32 for uint32_t).

Personally, I don't like those.

Checkpatch is run against a lot of code outside of the linux kernel but following linux coding style.

I know. I don't have any strong feeling about this either.

But _this_ checkpatch is specifically for the linux-kernel.

I just don't want to encourage a bunch of uses of these somewhat useless defines internal to linux-kernel sources.

Quoted 2 lines

There is nothing personal about this, they are the format specifiers in inttypes.h for fixed width types .

True. It's impersonal to me too.

Quoted 1 line
Quoted 1 line

scripts/checkpatch.pl

Quoted 1 line
scripts/checkpatch.pl +0 -0

[]

Quoted 6 lines
Quoted 6 lines

scripts/checkpatch.pl sub process { · line 5161

Quoted 6 lines
scripts/checkpatch.pl +2 -0
@@ -5157,6 +5157,8 @@ sub process {
   			    $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
   #Ignore Page<foo> variants
   			    $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
+#Ignore inttypes.h scanf/printf format specifiers for fixed size integer types
+			    $var !~ /^(?:PRI|SCN)[dxoui](8|16|32|64|PTR|MAX)?$/ &&

There are missing format specifiers.
If this is done, the test should be against a variable

Quoted 8 lines

Something like:

our $inttype_format = qr{(?x:

		(?:PRI|SCN)
		[diouxX]
		(?:FAST|LEAST)?
		(?:8|16|32|64|MAX|PTR)
};
Quoted 6 lines

I can try adding the "X" and FAST|LEAST.
But I am not familiar enough with perl or the checkpatch script to understand
what you mean by test should be against a variable vs what I have done.

Quoted 1 line

btw: what about 24, 48, 96, 128 and 256?

I can't find those values described for inttypes.h format specifiers.

There are others outside of linux.
http://cmod.gforge.inria.fr/doxygen/group__POSIX%E2%88%B7std%E2%88%B7inttypes%E2%88%B7__Snippet.html

Quoted 4 lines

Where are you looking at those values from?

Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
scripts/checkpatch.pl +0 -0
   #Ignore SI style variants like nS, mV and dB
   #(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
   			    $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ &&

Like this:

---
 scripts/checkpatch.pl | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)
scripts/checkpatch.pl +10 -1
index 524df88f9364..112ea055eba1 100755
@@ -565,6 +565,14 @@ our $C90_int_types = qr{(?x:
 	(?:(?:un)?signed\s+)?int
 )};
 
+# inttype.h formats
+our $inttype_formats = qr{(?x:
+	(?:PRI|SCN)
+	[diouxX]
+	(?:FAST|LEAST)?
+	(?:8|16|32|64|MAX|PTR)
+)};
+
 our @typeListFile = ();
 our @typeListWithAttr = (
 	@typeList,
@@ -5151,7 +5159,8 @@ sub process {
 #(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
 			    $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ &&
 #Ignore some three character SI units explicitly, like MiB and KHz
-			    $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
+			    $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/ &&
+			    $var !~ /^$inttype_formats$/) {
 				while ($var =~ m{($Ident)}g) {
 					my $word = $1;
 					next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);