]> git.ipfire.org Git - thirdparty/lxc.git/commitdiff
CODING_STYLE: Mention kernel style in introduction
authorTobin C. Harding <me@tobin.cc>
Fri, 17 Aug 2018 03:46:16 +0000 (13:46 +1000)
committerChristian Brauner <christian.brauner@ubuntu.com>
Mon, 10 Dec 2018 15:20:51 +0000 (16:20 +0100)
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>
CODING_STYLE.md

index 7f2df9ed2c178637eb5679e8c89523ded2de5267..c81015173aba2c1a1ce543d318123bc6df439a0d 100644 (file)
@@ -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