summaryrefslogtreecommitdiffstats
path: root/doc/coding-style.txt
diff options
context:
space:
mode:
authorDenis Kenzior <denkenz@gmail.com>2010-07-19 12:44:53 -0500
committerDenis Kenzior <denkenz@gmail.com>2010-07-19 12:44:53 -0500
commit252c2626ffe0992df3acb14509aaeb424cd19050 (patch)
tree394af7086041aedb95d19949bac886f5bd7a0faf /doc/coding-style.txt
parent0f1465ab86771f757d19439ea127ce5faa5342c0 (diff)
downloadofono-252c2626ffe0992df3acb14509aaeb424cd19050.tar.bz2
doc: reword some parts
Diffstat (limited to 'doc/coding-style.txt')
-rw-r--r--doc/coding-style.txt10
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/coding-style.txt b/doc/coding-style.txt
index f6c58f28..a5d7799b 100644
--- a/doc/coding-style.txt
+++ b/doc/coding-style.txt
@@ -10,12 +10,14 @@ First of all, oFono coding style must follow every rule for Linux kernel
named checkpatch.pl to help you check the compliance with it. Just type
"checkpatch.pl --no-tree patch_name" to check your patch. In theory, you need
to clean up all the warnings and errors except this one: "ERROR: Missing
-Signed-off-by: line(s)". However, sometimes, the warning of exceeding maximum
-characters for a line (80 characters) can be ignored.
+Signed-off-by: line(s)". oFono does not used Signed-Off lines, so including
+them is actually an error. In certain circumstances one can ignore the 80
+character per line limit. This is generally only allowed if the alternative
+would make the code even less readable.
Besides the kernel coding style above, oFono has special flavors for its own.
Some of them are mandatory (marked as 'M'), while some others are optional
-(marked as 'O'), but nice to have.
+(marked as 'O'), but generally preferred.
M1: Blank line before if statement
==================================
@@ -118,7 +120,7 @@ Better to use abbreviation, rather than full name, to name a variable,
function, struct, etc.
Example:
-supplementary_service // worse
+supplementary_service // too long
ss // better