Skip to contentSkip to conversation

Revert ".flake8: fix check for 80/132 columns"

PATCH New Yann E. MORIN 2 participants 2 messages Jan 2, 2021 Kbuild

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Revert ".flake8: fix check for 80/132 columns"

Commit 7d17ae2acf63 (.flake8: fix check for 80/132 columns) introduced a difference in how flake8 behaves between the automatic checks done in the CI, where the maximum line length is 132, and the local checks, where the maximum line length is 80.

The rationale at the time was that we recommend 80 char lines, but that we accept 132 when it makes sense for readability.

However, this is very annoying when running flake8 locally, because of two reasons:

1. human reviews on python scripts have not been as thorough as we did expect; indeed, we've let a lot of long lines slip through; this causes a lot of spurious failures that hide away the actual errors;

2. when hacking on a python script, the issues reported will not be caused by the current changes, so the many reported failures actually hide away the newly introduced issues.

Additionally, our 'make check-flake8' rule already enforces the 132-char limit, and the issues reported are different than when manually running flake8 on individual files.

Furthermore, the readability rationale for the 80-char limit is definitely shattered by the mere rationale of allowing 132-char limit for... readability...

We've arrived to a point where this separation is causing our checks around flake8 to become mostly unusable and useless, as they do not report meaningful issues, and people are no longer paying attention, and this has caused actual issues to be introduced.

Finally, terminal emulators of today have long lifted the 80-char limit, and are more than capable of displaying 132-char wide lines.

Switch back to using a 132-char limit.

This reverts commit 7d17ae2acf63810495cc480da38127c4612e4da9.

Cc Arnout Vandecappelle <[email protected]>
Cc Ricardo Martincoski <[email protected]>
Cc Thomas Petazzoni <[email protected]>
Cc Peter Korsgaard <[email protected]>
---
 .flake8  | 2 +-
 Makefile | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
.flake8 +1 -1
index ee3d5035a0..7dd7b541cc 100644
@@ -2,4 +2,4 @@
 exclude=
     # copied from the kernel sources
     utils/diffconfig
-max-line-length=80
+max-line-length=132
Makefile +1 -1
index f0b3e43e0f..4d334adcd6 100644
@@ -1223,7 +1223,7 @@ check-flake8:
 	| xargs file \
 	| grep 'Python script' \
 	| cut -d':' -f1 \
-	| xargs -- python3 -m flake8 --statistics --max-line-length=132
+	| xargs -- python3 -m flake8 --statistics
 
 check-package:
 	find $(TOPDIR) -type f \( -name '*.mk' -o -name '*.hash' -o -name 'Config.*' \) \
Signature · 1 line
2.25.1
#1 lore raw

PATCH 1/1 Revert ".flake8: fix check for 80/132 columns"

Quoted 44 lines · On Sat, 2 Jan 2021 11:56:05 +0100 "Yann E. MORIN" <[email protected]>…

Commit 7d17ae2acf63 (.flake8: fix check for 80/132 columns) introduced a difference in how flake8 behaves between the automatic checks done in the CI, where the maximum line length is 132, and the local checks, where the maximum line length is 80.

The rationale at the time was that we recommend 80 char lines, but that we accept 132 when it makes sense for readability.

However, this is very annoying when running flake8 locally, because of two reasons:

1. human reviews on python scripts have not been as thorough as we did expect; indeed, we've let a lot of long lines slip through; this causes a lot of spurious failures that hide away the actual errors;

2. when hacking on a python script, the issues reported will not be caused by the current changes, so the many reported failures actually hide away the newly introduced issues.

Additionally, our 'make check-flake8' rule already enforces the 132-char limit, and the issues reported are different than when manually running flake8 on individual files.

Furthermore, the readability rationale for the 80-char limit is definitely shattered by the mere rationale of allowing 132-char limit for... readability...

We've arrived to a point where this separation is causing our checks around flake8 to become mostly unusable and useless, as they do not report meaningful issues, and people are no longer paying attention, and this has caused actual issues to be introduced.

Finally, terminal emulators of today have long lifted the 80-char limit, and are more than capable of displaying 132-char wide lines.

Switch back to using a 132-char limit.

This reverts commit 7d17ae2acf63810495cc480da38127c4612e4da9.

Cc Arnout Vandecappelle <[email protected]>
Cc Ricardo Martincoski <[email protected]>
Cc Thomas Petazzoni <[email protected]>
Cc Peter Korsgaard <[email protected]>
Quoted 4 lines
---
 .flake8  | 2 +-
 Makefile | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

Applied to master, thanks.

Thomas

Signature · 3 lines
Thomas Petazzoni, CTO, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com