docs: Update the preferred line size to 100 characters
Subsystems (2)
PATCH 1/1 docs: Update the preferred line size to 100 characters
From: "Steven Rostedt (Google)" <[email protected]>
As commit bdc48fa11e46f ("checkpatch/coding-style: deprecate 80-column warning") states:
Increase the default limit to 100 characters. Not because 100 characters is some hard limit either, but that's certainly a "what are you doing" kind of value and less likely to be about the occasional slightly longer lines.
It's 2022, people are not using 80x24 terminals anymore (well I'm sure someone is, but they are the small minority).
--- Documentation/process/coding-style.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
Documentation/process/coding-style.rst +3 -3
@@ -101,10 +101,10 @@ Get a decent editor and don't leave whitespace at the end of lines. Coding style is all about readability and maintainability using commonly available tools. -The preferred limit on the length of a single line is 80 columns. +The preferred limit on the length of a single line is 100 columns. -Statements longer than 80 columns should be broken into sensible chunks, -unless exceeding 80 columns significantly increases readability and does +Statements longer than 100 columns should be broken into sensible chunks, +unless exceeding 100 columns significantly increases readability and does not hide information. Descendants are always substantially shorter than the parent and
Signature · 1 line
2.33.0
Randy Dunlap
reviewerQuoted 9 lines · Steven Rostedt
From: "Steven Rostedt (Google)" <[email protected]>
As commit
bdc48fa11e46f("checkpatch/coding-style: deprecate 80-column warning") states:Increase the default limit to 100 characters. Not because 100 characters is some hard limit either, but that's certainly a "what are you doing" kind of value and less likely to be about the occasional slightly longer lines.
Has Linus has changed his view on this since 2016?
https://lore.kernel.org/all/CA+55aFxaOFoh+Zrm5tNhU4hWu4Z032+nqV3vXK=QPJyhZsU3_A@mail.gmail.com/
Guess we will see.
I expect that the answer is "be reasonable," but that's subjective.
To me, it is easier to look below one line for something in context than it is to have to scan several inches to the right and then back to the left (or vice versa). Maybe I'm alone in that, but I doubt it.
It's sort of a locality of vision thing.
Quoted 26 lines
It's 2022, people are not using 80x24 terminals anymore (well I'm sure someone is, but they are the small minority).
Signed-off-by Steven Rostedt (Google) <[email protected]>--- Documentation/process/coding-style.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)Documentation/process/coding-style.rst +3
-3@@ -101,10 +101,10 @@ Get a decent editor and don't leave whitespace at the end of lines. Coding style is all about readability and maintainability using commonly available tools. -The preferred limit on the length of a single line is 80 columns. +The preferred limit on the length of a single line is 100 columns. -Statements longer than 80 columns should be broken into sensible chunks, -unless exceeding 80 columns significantly increases readability and does +Statements longer than 100 columns should be broken into sensible chunks, +unless exceeding 100 columns significantly increases readability and does not hide information. Descendants are always substantially shorter than the parent and
Signature · 1 line
~Randy
Quoted 16 lines · Randy Dunlap
Quoted 9 lines · Steven Rostedt
From: "Steven Rostedt (Google)" <[email protected]>
As commit
bdc48fa11e46f("checkpatch/coding-style: deprecate 80-column warning") states:Increase the default limit to 100 characters. Not because 100 characters is some hard limit either, but that's certainly a "what are you doing" kind of value and less likely to be about the occasional slightly longer lines.
Has Linus has changed his view on this since 2016?
https://lore.kernel.org/all/CA+55aFxaOFoh+Zrm5tNhU4hWu4Z032+nqV3vXK=QPJyhZsU3_A@mail.gmail.com/
Quoted 6 lines
Guess we will see.
I expect that the answer is "be reasonable," but that's subjective.To me, it is easier to look below one line for something in context than it is to have to scan several inches to the right and then back to the left (or vice versa). Maybe I'm alone in that, but I doubt it.
You are not alone.
Reading left to right is relatively easy but for long line lengths the eye movement to the next appropriate line is not at all easy.
Quoted 1 line
It's sort of a locality of vision thing.
Yup.
I think this is not a good patch.
The preferred line length should stay relatively small at 80 and not allow an entire file to be wrapped to 100.
I'd still prefer a warning when any new identifier is longer than some length like say 20 characters.
Quoted 27 lines
Quoted 26 lines
It's 2022, people are not using 80x24 terminals anymore (well I'm sure someone is, but they are the small minority).
Signed-off-by Steven Rostedt (Google) <[email protected]>--- Documentation/process/coding-style.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)Documentation/process/coding-style.rst +3
-3@@ -101,10 +101,10 @@ Get a decent editor and don't leave whitespace at the end of lines. Coding style is all about readability and maintainability using commonly available tools. -The preferred limit on the length of a single line is 80 columns. +The preferred limit on the length of a single line is 100 columns. -Statements longer than 80 columns should be broken into sensible chunks, -unless exceeding 80 columns significantly increases readability and does +Statements longer than 100 columns should be broken into sensible chunks, +unless exceeding 100 columns significantly increases readability and does not hide information. Descendants are always substantially shorter than the parent and
Hi Steven,
Thank you for cc'ing me.
Quoted 24 lines · Steven Rostedt
From: "Steven Rostedt (Google)" <[email protected]>
As commit
bdc48fa11e46f("checkpatch/coding-style: deprecate 80-column warning") states:Increase the default limit to 100 characters. Not because 100 characters is some hard limit either, but that's certainly a "what are you doing" kind of value and less likely to be about the occasional slightly longer lines.
It's 2022, people are not using 80x24 terminals anymore (well I'm sure someone is, but they are the small minority).
Signed-off-by Steven Rostedt (Google) <[email protected]>--- Documentation/process/coding-style.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)Documentation/process/coding-style.rst +0
-0@@ -101,10 +101,10 @@ Get a decent editor and don't leave whitespace at the end of lines. Coding style is all about readability and maintainability using commonly
Documentation/process/coding-style.rst Get a decent editor and don't leave whitespace at the end of lines. · line 108
Quoted 10 lines
Documentation/process/coding-style.rst +3
-3available tools. -The preferred limit on the length of a single line is 80 columns. +The preferred limit on the length of a single line is 100 columns. -Statements longer than 80 columns should be broken into sensible chunks, -unless exceeding 80 columns significantly increases readability and does +Statements longer than 100 columns should be broken into sensible chunks, +unless exceeding 100 columns significantly increases readability and does not hide information.
As others have already opined, I agree that increasing the line length from 80 isn't going to make the code universally (or even mostly) more readable. There are probably cases it does but this is not necessarily common.
I think the original text puts it well: there is a limit of 80 but that is not a hard limit. When reviewing code, I often ask to wrap lines if there's really no reason to keep them longer (in this case that seldom is the only problem with the code). Of course you could argue what these reasons might be. At the very least indentation has a higher precedence that the line length. This is also written in the documentation.
My view is that this recommendation is not, at least today, relevant for the purpose of making the code readable for someone with a VT100 terminal, but a part of a recipe for writing good code simply expressed in units everyone knows: VT100 terminal size. Also 80x24 is still the default window size of many if not most terminal emulators.
Signature · 3 lines
Kind regards, Sakari Ailus