mirrors
/
linux-stable
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
1
0
Fork 0
Code Issues Releases Wiki Activity

CodingStyle: Document the exception of not splitting user-visible strings, for grepping 

Patch reviewers now recommend not splitting long user-visible strings,
such as printk messages, even if they exceed 80 columns.  This avoids
breaking grep.  However, that recommendation did not actually appear
anywhere in Documentation/CodingStyle.

See, for example, the thread at
  http://news.gmane.org/find-root.php?message_id=%3c1312215262.11635.15.camel%40Joe%2dLaptop%3e

Signed-off-by: Josh Triplett <josh@joshtriplett.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
This commit is contained in:
Josh Triplett 2011-08-03 12:19:07 -07:00 committed by Linus Torvalds
parent 1117f72ea0
commit 6f76b6fcaa
1 changed files with 6 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
Documentation/CodingStyle
View File

@ -80,22 +80,13 @@ available tools.
The limit on the length of lines is 80 columns and this is a strongly The limit on the length of lines is 80 columns and this is a strongly
preferred limit. preferred limit.
Statements longer than 80 columns will be broken into sensible chunks. Statements longer than 80 columns will be broken into sensible chunks, unless
Descendants are always substantially shorter than the parent and are placed exceeding 80 columns significantly increases readability and does not hide
substantially to the right. The same applies to function headers with a long information. Descendants are always substantially shorter than the parent and
argument list. Long strings are as well broken into shorter strings. The are placed substantially to the right. The same applies to function headers
only exception to this is where exceeding 80 columns significantly increases with a long argument list. However, never break user-visible strings such as
readability and does not hide information. printk messages, because that breaks the ability to grep for them.
void fun(int a, int b, int c)
{
if (condition)
printk(KERN_WARNING "Warning this is a long printk with "
"3 parameters a: %u b: %u "
"c: %u \n", a, b, c);
else
next_statement;
}
Chapter 3: Placing Braces and Spaces Chapter 3: Placing Braces and Spaces