From 56b058813306d1b28e1b2849617f6a576821a58a Mon Sep 17 00:00:00 2001
From: yoe <yoe>
Date: Sat, 5 Aug 2006 09:21:14 +0000
Subject: [PATCH] r176: Add CodingStyle document

---
 CodingStyle |   46 ++++++++++++++++++++++++++++++++++++++++++++++
 Makefile.am |    2 +-
 2 files changed, 47 insertions(+), 1 deletion(-)
 create mode 100644 CodingStyle

diff --git a/CodingStyle b/CodingStyle
new file mode 100644
index 0000000..d17906c
--- /dev/null
+++ b/CodingStyle
@@ -0,0 +1,46 @@
+NBD Coding style.
+=================
+
+The following expresses my opinion of what C code should look like. I'm
+not as strict as the Kernel maintainers on this one (NBD isn't even
+remotely as large anyway), but code that does not follow these rules
+needs to be updated so that it does, which is useless time wasted for
+me. Therefore, it's appreciated if you would follow these rules.
+
+Thanks.
+
+* Use a tab width of 8 characters. You may use tab or 8 spaces as you
+  please, it doesn't really matter to me.
+* opening curly brackets occur on the same line as whatever they're
+  curly brackets for, _in all cases_. This includes function
+  definitions, if structures, loops, and so on; every code block appears
+  like so:
+
+int foo(int bar) {
+  	...
+}
+
+* Variable declarations are separated from the rest of a function block
+  by a line of whitespace. It's okay to assign a value to a variable
+  when you're declaring it if you can do that on one line of code, but
+  it must still be in the block of declarations at the top with a
+  whiteline below.
+* Variables are declared one on each line. So no
+
+	int foo, bar;
+
+  use
+
+	int foo;
+	int bar;
+
+  instead.
+* Try to fit everything in 80 columns. This goes especially for comment
+  lines, but may be relaxed for function calls with 79 arguments, or so,
+  if that's not feasible.
+* If your function block is more than three or so screenfulls, there's a
+  hint that you should break it up.
+
+It is true that not all of the code currently follows these rules; but
+that should not stop you from following them for new code, or from
+cleaning up if you can (i.e., you have commit rights).
diff --git a/Makefile.am b/Makefile.am
index dea3551..1c8c837 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -10,7 +10,7 @@ nbd_tester_client_LDADD = @GLIB_LIBS@
 nbd_server_LDADD = @GLIB_LIBS@
 nbd_tester_client_LDADD = @GLIB_LIBS@
 man_MANS = nbd-server.1 nbd-client.8
-EXTRA_DIST = nbd-client.8.sgml nbd-server.1.sgml gznbd winnbd lfs.h nbd-client.8 nbd-server.1
+EXTRA_DIST = nbd-client.8.sgml nbd-server.1.sgml gznbd winnbd lfs.h nbd-client.8 nbd-server.1 CodingStyle
 MAINTAINERCLEANFILES = nbd-client.8 nbd-server.1
 nbd-server.1: nbd-server.1.sgml
 	docbook2man nbd-server.1.sgml
-- 
1.7.10.4