checkpatch: warn about uses of ENOTSUPP
Subsystems (3)
Jakub Kicinski
maintainerPATCH v2 1/1 checkpatch: warn about uses of ENOTSUPP
ENOTSUPP often feels like the right error code to use, but it's in fact not a standard Unix error. E.g.:
$ python
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
import errno
errno.errorcode[errno.ENOTSUPP]
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
AttributeError: module 'errno' has no attribute 'ENOTSUPP'
There were numerous commits converting the uses back to EOPNOTSUPP but in some cases we are stuck with the high error code for backward compatibility reasons.
Let's try prevent more ENOTSUPPs from getting into the kernel.
Recent example:
https://lore.kernel.org/netdev/[email protected]/
v2 (Joe):
- add a link to recent discussion,
- don't match when scanning files, not patches to avoid sudden influx of conversion patches.
v1:
https://lore.kernel.org/netdev/[email protected]/
--- scripts/checkpatch.pl | 11 +++++++++++ 1 file changed, 11 insertions(+)
scripts/checkpatch.pl +11 -0
@@ -4199,6 +4199,17 @@ sub process { "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); } +# ENOTSUPP is not a standard error code and should be avoided in new patches. +# Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP. +# Similarly to ENOSYS warning a small number of false positives is expected. + if (~$file && $line =~ /\bENOTSUPP\b/) { + if (WARN("ENOTSUPP", + "ENOTSUPP is not a SUSV4 error code, prefer EOPNOTSUPP\n" . $herecurr) && + $fix) { + $fixed[$fixlinenr] =~ s/\bENOTSUPP\b/EOPNOTSUPP/; + } + } + # function brace can't be on same line, except for #defines of do while, # or if closed on same line if ($perl_version_ok &&
Signature · 1 line
2.25.4
Quoted 2 lines · Jakub Kicinski
ENOTSUPP often feels like the right error code to use, but it's in fact not a standard Unix error. E.g.:
[]
scripts/checkpatch.pl
Quoted 1 line
scripts/checkpatch.pl +0
-0
[]
scripts/checkpatch.pl sub process { · line 4205
Quoted 8 lines
scripts/checkpatch.pl +4
-0@@ -4199,6 +4199,17 @@ sub process { "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); } +# ENOTSUPP is not a standard error code and should be avoided in new patches. +# Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP. +# Similarly to ENOSYS warning a small number of false positives is expected. + if (~$file && $line =~ /\bENOTSUPP\b/) {
It's probably my typo or my brain thinking "not" and hitting the tilde and not the bang, but this should be
if (!$file & ...)
Otherwise:
Quoted 10 lines
scripts/checkpatch.pl +7
-0+ if (WARN("ENOTSUPP", + "ENOTSUPP is not a SUSV4 error code, prefer EOPNOTSUPP\n" . $herecurr) && + $fix) { + $fixed[$fixlinenr] =~ s/\bENOTSUPP\b/EOPNOTSUPP/; + } + } + # function brace can't be on same line, except for #defines of do while, # or if closed on same line if ($perl_version_ok &&
Jakub Kicinski
maintainerQuoted 18 lines · On Mon, 11 May 2020 10:03:31 -0700 Joe Perches wrote:
Quoted 2 lines · Jakub Kicinski
ENOTSUPP often feels like the right error code to use, but it's in fact not a standard Unix error. E.g.:
[]
scripts/checkpatch.pl
Quoted 1 line
scripts/checkpatch.pl +0
-0[]
scripts/checkpatch.pl sub process { · line 4205
Quoted 8 lines
scripts/checkpatch.pl +4
-0@@ -4199,6 +4199,17 @@ sub process { "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); } +# ENOTSUPP is not a standard error code and should be avoided in new patches. +# Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP. +# Similarly to ENOSYS warning a small number of false positives is expected. + if (~$file && $line =~ /\bENOTSUPP\b/) {It's probably my typo or my brain thinking "not" and hitting the tilde and not the bang, but this should be
Quoted 1 line
if (!$file & ...)
Ahh! :)
Quoted 3 lines
Otherwise:
Acked-by Joe Perches <[email protected]>
Thanks!