From: Tobin C. Harding <me@tobin.cc>
Date: Fri, 17 Aug 2018 03:46:16 +0000 (+1000)
Subject: CODING_STYLE: Mention kernel style in introduction
X-Git-Tag: lxc-3.1.0~156^2~5
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=183d7fa5ce9135be07e057ac6b000fec536285f9;p=thirdparty%2Flxc.git

CODING_STYLE: Mention kernel style in introduction

Currently the coding style guide does not mention that we use kernel
coding style as a base style for LXC.  We have just linked to
CODING_STLYE.md from CONTRIBUTING (which mentions use of kernel coding
style).  We can increase documentation congruence and completeness by
mentioning kernel coding style guide in the introduction to our style
guide.

Add heading and introduction to coding style guide informing readers
that we follow kernel coding style as a base before explaining our style
additions.

Signed-off-by: Tobin C. Harding <me@tobin.cc>
---

diff --git a/CODING_STYLE.md b/CODING_STYLE.md
index 7f2df9ed2..c81015173 100644
--- a/CODING_STYLE.md
+++ b/CODING_STYLE.md
@@ -1,3 +1,17 @@
+LXC Coding Style Guide
+======================
+
+In general the LXC project follows the Linux kernel coding style.  There are
+however are a few differences, these are outlined in this document.
+
+The Linux kernel coding style guide can be found within the kernel tree:
+
+	Documentation/process/coding-style.rst
+
+It can be accessed online too:
+
+https://www.kernel.org/doc/html/latest/process/coding-style.html
+
 #### General Notes
 
 - The coding style guide refers to new code. But legacy code can be cleaned up