Change in ...coreboot[master]: Documentation: Our coding style now allows 80 + 2*8 columns in a line
Patrick Georgi has uploaded this change for review. ( https://review.coreboot.org/c/coreboot/+/31771
Change subject: Documentation: Our coding style now allows 80 + 2*8 columns in a line ......................................................................
Documentation: Our coding style now allows 80 + 2*8 columns in a line
Update the document to match clang-format and checkpatch formally, and provide a rationale.
Change-Id: I597a27d4e22d07e033b36f0dceb554ac1d8d5789 Signed-off-by: Patrick Georgi pgeorgi@google.com --- M Documentation/coding_style.md 1 file changed, 8 insertions(+), 4 deletions(-)
git pull ssh://review.coreboot.org:29418/coreboot refs/changes/71/31771/1
diff --git a/Documentation/coding_style.md b/Documentation/coding_style.md index 048b8e6..14e32ce 100644 --- a/Documentation/coding_style.md +++ b/Documentation/coding_style.md @@ -29,6 +29,10 @@ 80-character terminal screen. The answer to that is that if you need more than 3 levels of indentation, you're screwed anyway, and should fix your program. +Since most code in a file is indented at least 1 level, we account for +2 levels in addition to the 80 characters on the terminal under the +assumption that editors can scroll to the right, making an 80 characters +screen visible with little loss on the left end.
In short, 8-char indents make things easier to read, and have the added benefit of warning you when you're nesting your functions too deep. @@ -80,11 +84,11 @@ Coding style is all about readability and maintainability using commonly available tools.
-The limit on the length of lines is 80 columns and this is a strongly -preferred limit. +The limit on the length of lines is 96 columns (80 columns + 2 tab levels) +and this is a strongly preferred limit.
-Statements longer than 80 columns will be broken into sensible chunks, -unless exceeding 80 columns significantly increases readability and does +Statements longer than 96 columns will be broken into sensible chunks, +unless exceeding 96 columns significantly increases readability and does not hide information. Descendants are always substantially shorter than the parent and are placed substantially to the right. The same applies to function headers with a long argument list. However, never break
Paul Menzel has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/31771 )
Change subject: Documentation: Our coding style now allows 80 + 2*8 columns in a line ......................................................................
Patch Set 2: Code-Review+1
(1 comment)
https://review.coreboot.org/#/c/31771/2/Documentation/coding_style.md File Documentation/coding_style.md:
https://review.coreboot.org/#/c/31771/2/Documentation/coding_style.md@31 PS2, Line 31: fix your program. Please add a blank line below.
Patrick Georgi has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/31771 )
Change subject: Documentation: Our coding style now allows 80 + 2*8 columns in a line ......................................................................
Patch Set 2:
(1 comment)
https://review.coreboot.org/#/c/31771/2/Documentation/coding_style.md File Documentation/coding_style.md:
https://review.coreboot.org/#/c/31771/2/Documentation/coding_style.md@31 PS2, Line 31: fix your program.
Please add a blank line below.
Done
Hello Paul Menzel, build bot (Jenkins),
I'd like you to reexamine a change. Please visit
https://review.coreboot.org/c/coreboot/+/31771
to look at the new patch set (#3).
Change subject: Documentation: Our coding style now allows 80 + 2*8 columns in a line ......................................................................
Documentation: Our coding style now allows 80 + 2*8 columns in a line
Update the document to match clang-format and checkpatch formally, and provide a rationale.
Change-Id: I597a27d4e22d07e033b36f0dceb554ac1d8d5789 Signed-off-by: Patrick Georgi pgeorgi@google.com --- M Documentation/coding_style.md 1 file changed, 9 insertions(+), 4 deletions(-)
git pull ssh://review.coreboot.org:29418/coreboot refs/changes/71/31771/3
Philipp Deppenwiese has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/31771 )
Change subject: Documentation: Our coding style now allows 80 + 2*8 columns in a line ......................................................................
Patch Set 3: Code-Review+2
Patrick Georgi has submitted this change and it was merged. ( https://review.coreboot.org/c/coreboot/+/31771 )
Change subject: Documentation: Our coding style now allows 80 + 2*8 columns in a line ......................................................................
Documentation: Our coding style now allows 80 + 2*8 columns in a line
Update the document to match clang-format and checkpatch formally, and provide a rationale.
Change-Id: I597a27d4e22d07e033b36f0dceb554ac1d8d5789 Signed-off-by: Patrick Georgi pgeorgi@google.com Reviewed-on: https://review.coreboot.org/c/coreboot/+/31771 Tested-by: build bot (Jenkins) no-reply@coreboot.org Reviewed-by: Philipp Deppenwiese zaolin.daisuki@gmail.com --- M Documentation/coding_style.md 1 file changed, 9 insertions(+), 4 deletions(-)
Approvals: build bot (Jenkins): Verified Philipp Deppenwiese: Looks good to me, approved
diff --git a/Documentation/coding_style.md b/Documentation/coding_style.md index 048b8e6..e034193 100644 --- a/Documentation/coding_style.md +++ b/Documentation/coding_style.md @@ -30,6 +30,11 @@ more than 3 levels of indentation, you're screwed anyway, and should fix your program.
+Since most code in a file is indented at least 1 level, we account for +2 levels in addition to the 80 characters on the terminal under the +assumption that editors can scroll to the right, making an 80 characters +screen visible with little loss on the left end. + In short, 8-char indents make things easier to read, and have the added benefit of warning you when you're nesting your functions too deep. Heed that warning. @@ -80,11 +85,11 @@ Coding style is all about readability and maintainability using commonly available tools.
-The limit on the length of lines is 80 columns and this is a strongly -preferred limit. +The limit on the length of lines is 96 columns (80 columns + 2 tab levels) +and this is a strongly preferred limit.
-Statements longer than 80 columns will be broken into sensible chunks, -unless exceeding 80 columns significantly increases readability and does +Statements longer than 96 columns will be broken into sensible chunks, +unless exceeding 96 columns significantly increases readability and does not hide information. Descendants are always substantially shorter than the parent and are placed substantially to the right. The same applies to function headers with a long argument list. However, never break
-
Patrick Georgi (Code Review) -
Paul Menzel (Code Review)
-
Philipp Deppenwiese (Code Review)