瀏覽代碼

Add a "CODING" file, in which our naming conventions and elements of style may be found.

Cyril Roelandt 13 年之前
父節點
當前提交
53e4220c50
共有 2 個文件被更改,包括 23 次插入16 次删除
  1. 23 0
      CODING
  2. 0 16
      README.dev

+ 23 - 0
CODING

@@ -0,0 +1,23 @@
+Naming Conventions
+------------------
+
+* Prefix names of public objects (types, functions, etc.) with "starpu"
+
+* Prefix names of internal objects (types, functions, etc.) with "_starpu"
+
+* Names for qualified types (struct, union, enum) do not end with _t, _s or similar.
+  Use _t only for typedef types, such as opaque public types, e.g
+       typedef struct _starpu_data_state* starpu_data_handle_t;
+  or
+       typedef uint64_t starpu_tag_t;
+
+* When a variable can only take a finite set of values, use an enum
+  type instead of defining macros for each of the values.
+
+
+
+
+
+Style
+-----
+* curly braces always go on a new line

+ 0 - 16
README.dev

@@ -31,22 +31,6 @@ They are enabled only if the STARPU_DEVEL environment variable is
 defined to a non-empty value, when calling configure.
 
 
-Coding Conventions
-------------------
-
-- Prefix names of public objects (types, functions, etc.) with "starpu"
-
-- Prefix names of internal objects (types, functions, etc.) with "_starpu"
-
-- Names for qualified types (struct, union, enum) do not end with _t, _s or similar.
-  Use _t only for typedef types, such as opaque public types, e.g
-       typedef struct _starpu_data_state* starpu_data_handle_t;
-  or
-       typedef uint64_t starpu_tag_t;
-
-- When a variable can only take a finite set of values, use an enum
-  type instead of defining macros for each of the values.
-
 
 
 Installing StarPU on windows