Merge prog_std.txt into coding_style.md

neutrinolabs · Oct 17, 2016 · acdfc94 · acdfc94
1 parent c910824
commit acdfc94
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 44 deletions.
diff --git a/Makefile.am b/Makefile.am
@@ -2,7 +2,7 @@ ACLOCAL_AMFLAGS = -I m4
 AM_DISTCHECK_CONFIGURE_FLAGS = --without-systemdsystemunitdir
 
 EXTRA_DIST = bootstrap COPYING coding_style.md design.txt faq-compile.txt \
-  faq-general.txt file-loc.txt install.txt m4 prog_std.txt readme.txt
+  faq-general.txt file-loc.txt install.txt m4 readme.txt
 
 if XRDP_NEUTRINORDP
 NEUTRINORDPDIR = neutrinordp

diff --git a/coding_style.md b/coding_style.md
@@ -15,6 +15,13 @@ Here is how we run the astyle command:
 This coding style is a work in progress and is still evolving.
 
 
+Language Standard
+-----------------
+
+Try to make all code compile with both C and C++ compiler. C++ is more
+strict, which makes the code safer.
+
+
 Indentation
 -----------
 
@@ -32,7 +39,7 @@ Indentation
 Line wrapping
 -------------
 
-* Keep lines shorter than 80 chars
+* Keep lines not longer than 80 chars
 * Align wrapped argument to the first argument
 
 ☞
@@ -46,9 +53,11 @@ Variable names
 
 * Use lowercase with underscores as needed
 * Don't use camelCase
+* Preprocessor constants should be uppercase
 
 ☞
 
+    #define BUF_SIZE 1024
     int fd;
     int bytes_in_stream;
 
@@ -193,3 +202,9 @@ Braces
         default:
             printf("bad cmd\n");
     }
+
+Comments
+--------
+
+Use /* */ for comments
+Don't use //
diff --git a/prog_std.txt b/prog_std.txt
diff --git a/readme.txt b/readme.txt
@@ -21,7 +21,7 @@ xup is a module used to connect to an rdp specific X11 server
 Xserver is the files needed to build an rdp specific X11 server
 COPYING is the license file
 design.txt is an attempt to explain the project design
-prog_std.txt is an attempt to explain the programming standard used
+coding_style.md describes the coding style for the project
 
 since version 0.5.0 we switch to autotools to build xrdp