proxmox-mirrors/mirror_lxc
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_lxc synced 2025-08-16 00:15:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

CODING_STYLE: Mention kernel style in introduction

Browse Source 
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>
This commit is contained in:
Tobin C. Harding 2018-08-17 13:46:16 +10:00
parent 54df5d72ed
commit 183d7fa5ce
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
CODING_STYLE.md
View 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