libxl: CODING_STYLE: Discuss existing style problems
authorIan Jackson <ian.jackson@eu.citrix.com>
Wed, 5 Nov 2014 14:32:47 +0000 (14:32 +0000)
committerIan Jackson <Ian.Jackson@eu.citrix.com>
Tue, 18 Nov 2014 14:51:56 +0000 (14:51 +0000)
Document that:
 - the existing code is not all confirming yet
 - code should conform
 - we will sometimes accept patches with nonconforming elements if
   they don't make matters worse.

Signed-off-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
Acked-by: Wei Liu <wei.liu2@citrix.com>
Release-Acked-by: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
tools/libxl/CODING_STYLE

index 9a1d6e093332df678a7b34b76bca7571aced337c..f5b58909b34d158f4c06bb3e279f6648b1aa01ec 100644 (file)
@@ -2,6 +2,24 @@ LIBXENLIGHT CODING STYLE
 ========================
 
 
+AN APOLOGY AND WARNING
+----------------------
+
+Much of the code in libxl does not yet follow this coding style
+document in every respect.  However, new code is expected to conform.
+
+Patches to improve the style of existing code are welcome.  Please
+separate these out from functional changes.
+
+If it is not feasible to conform fully to the style while patching old
+code, without doing substantial style reengineering first, we may
+accept patches which contain nonconformant elements, provided that
+they don't make the coding style problem worse overall.
+
+In this case, the new code should conform to the prevailing style in
+the area being touched.
+
+
 MEMORY ALLOCATION
 -----------------