summaryrefslogtreecommitdiff
path: root/Documentation/CodingConventions
diff options
context:
space:
mode:
authorDavid Sterba <dsterba@suse.com>2017-05-18 18:49:00 +0200
committerDavid Sterba <dsterba@suse.com>2017-07-03 13:35:10 +0200
commitcc5c10b675dd54156536e01653ce6081e9f57576 (patch)
tree0f5c03ed20869752965d96856c4a0acde28a54a6 /Documentation/CodingConventions
parent88221fc081a7a0979a012f243b66cf097382cc8f (diff)
btrfs-progs: docs: document conventions
Signed-off-by: David Sterba <dsterba@suse.com>
Diffstat (limited to 'Documentation/CodingConventions')
-rw-r--r--Documentation/CodingConventions19
1 files changed, 19 insertions, 0 deletions
diff --git a/Documentation/CodingConventions b/Documentation/CodingConventions
new file mode 100644
index 00000000..cee90b30
--- /dev/null
+++ b/Documentation/CodingConventions
@@ -0,0 +1,19 @@
+C style
+-------
+
+The kernel CodingStyle where applicable
+
+https://www.kernel.org/doc/html/latest/process/coding-style.html
+
+Error messages
+--------------
+
+* formatting:
+ * use `error("string ...")`
+ * no trailing newline
+ * small letter starts the first word
+ * no string splitting
+ * move string to new line if it's too long, un-indent to the left if it
+ exceeds 80 chars
+* contents:
+ * be descriptive