[PATCH v3] checkpatch: allow URL >80 chars

[PATCH v3] checkpatch: allow URL >80 chars

[Andreas Brauchli]

Allow URL to exceed the 80 char limit for improved interaction in
adaption to ongoing but undocumented practice.

$ git grep -E '://\S{77}.*' -- '*.[ch]'

The patch checks that the URL is indeed on its own line in that
only non-word (\W) and underscore characters are allowed beside the
URL (e.g. ' /* _https://..._ */')

As per RFC3986 [1], the URL format allows for alphanum, +, - and .
characters in the scheme before the separator :// as long as it starts
with a letter (e.g. https, git, f.-+).

Recognition of URIs without more context information is prone to false
positives and thus currently left out of the heuristics.

$rawline is used in the check as comments are removed from $line.

[1] https://tools.ietf.org/html/rfc3986#section-3.1

Signed-off-by: Andreas Brauchli <andreas.brauchli@sensirion.com>
---
 scripts/checkpatch.pl | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 95cda3ecc66b..ac223921f7e0 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -2906,6 +2906,10 @@ sub process {
 				 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
 				$msg_type = "";
 
+			# URL (w/ non-word char padding e.g. " /* */")
+			} elsif ($rawline =~ /^\+[\W_]*?\b([a-z][\w\.\+\-]*:\/\/\S+[^\s\)\]\.">;,])[\W_]*$/i) {
+				$msg_type = "";
+
 			# Otherwise set the alternate message types
 
 			# a comment starts before $max_line_length
-- 
2.14.1

Re: [PATCH v3] checkpatch: allow URL >80 chars

[Joe Perches]

On Tue, 2017-11-21 at 22:50 +0100, Andreas Brauchli wrote:
> Allow URL to exceed the 80 char limit for improved interaction in
> adaption to ongoing but undocumented practice.
> 
> $ git grep -E '://\S{77}.*' -- '*.[ch]'
> 
> The patch checks that the URL is indeed on its own line in that
> only non-word (\W) and underscore characters are allowed beside the
> URL (e.g. ' /* _https://..._ */')

Perhaps you are overthinking it.

If a line contains a URL, and it's > $max_line_length,
then it's probably OK not to warn about it as as overly
long line.

I suggest:

---
 scripts/checkpatch.pl | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 95cda3ecc66b..0e42e5ebe2f0 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -2875,6 +2875,7 @@ sub process {
 #	logging functions like pr_info that end in a string
 #	lines with a single string
 #	#defines that are a single string
+#	lines with an RFC3986 like URL
 #
 # There are 3 different line length message types:
 # LONG_LINE_COMMENT	a comment starts before but extends beyond $max_line_length
@@ -2906,6 +2907,10 @@ sub process {
 				 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
 				$msg_type = "";
 
+			# URL ($rawline is used if the URL is in a comment)
+			} elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
+				$msg_type = "";
+
 			# Otherwise set the alternate message types
 
 			# a comment starts before $max_line_length

Re: [PATCH v3] checkpatch: allow URL >80 chars

[Andreas Brauchli]

On Die, 2017-11-21 at 17:05 -0800, Joe Perches wrote:
> On Tue, 2017-11-21 at 22:50 +0100, Andreas Brauchli wrote:
> > Allow URL to exceed the 80 char limit for improved interaction in
> > adaption to ongoing but undocumented practice.
> > 
> > $ git grep -E '://\S{77}.*' -- '*.[ch]'
> > 
> > The patch checks that the URL is indeed on its own line in that
> > only non-word (\W) and underscore characters are allowed beside the
> > URL (e.g. ' /* _https://..._ */')
> 
> Perhaps you are overthinking it.
> 
> If a line contains a URL, and it's > $max_line_length,
> then it's probably OK not to warn about it as as overly
> long line.

Yes, I see. I was going for a different solution: if the URL is already
over the allowable length, no other content parts would be allowed on
the same line.

> 
> I suggest:
> 
> ---
>  scripts/checkpatch.pl | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> index 95cda3ecc66b..0e42e5ebe2f0 100755
> --- a/scripts/checkpatch.pl
> +++ b/scripts/checkpatch.pl
> @@ -2875,6 +2875,7 @@ sub process {
>  #	logging functions like pr_info that end in a string
>  #	lines with a single string
>  #	#defines that are a single string
> +#	lines with an RFC3986 like URL
>  #
>  # There are 3 different line length message types:
>  # LONG_LINE_COMMENT	a comment starts before but extends beyond $max_line_length
> @@ -2906,6 +2907,10 @@ sub process {
>  				 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
>  				$msg_type = "";
>  
> +			# URL ($rawline is used if the URL is in a comment)
> +			} elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-
> +				$msg_type = "";
> +
>  			# Otherwise set the alternate message types
>  
>  			# a comment starts before $max_line_length

Thanks, I'll resend this as v4

Thanks,
Andreas