[Spice-devel] [PATCH v3 02/11] Added External References section

[Christophe de Dinechin]

From: Christophe de Dinechin <dinechin at redhat.com>

Signed-off-by: Christophe de Dinechin <dinechin at redhat.com>
---
 docs/spice_style.txt | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/docs/spice_style.txt b/docs/spice_style.txt
index f5d13642..10bfbc9a 100644
--- a/docs/spice_style.txt
+++ b/docs/spice_style.txt
@@ -6,6 +6,26 @@ Licensed under a Creative Commons Attribution-Share Alike 3.0
 United States License (see http://creativecommons.org/licenses/by-sa/3.0/us/legalcode).
 
 
+External references
+-------------------
+
+In general, unless otherwise noted here (e.g. the use of tabs),
+
+- For C code, SPICE follows the Linux kernel coding conventions as documented here: https://www.kernel.org/doc/html/v4.10/process/coding-style.html.
+  Notable deviations from the Linux coding style include:
+  + The use of 4 spaces for indentation instead of tabs
+  + The use of typedefs for structs not considered as a mistake
+  + The use of CamelCase for struct and class names
+
+- For C++ code, SPICE follows the LLVM coding standard (https://llvm.org/docs/CodingStandards.html).
+  Notable deviations from the LLVM coding style include:
+  + The format of header comments
+  + The placement of braces after functions and classes (follows the Linux style)
+
+In addition, for C++, developers should be aware of the C++ Core Guidelines and consider them as best practice unless otherwise agreed on by the team
+https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md
+
+
 Source Files
 ------------
 
-- 
2.13.5 (Apple Git-94)