Difference between revisions of "Coding Rules"

From ArmadeusWiki
Jump to: navigation, search
(New page: This page defines the Coding Rules that apply to all the source code of the Armadeus Project BSP. ==C files== * Both userspace or driver code shall use the Linux kernel "coding style". De...)
 
m (C files)
Line 3: Line 3:
 
==C files==
 
==C files==
 
* Both userspace or driver code shall use the Linux kernel "coding style". Details are given here: ''buildroot/output/build/linux-x.x/Documentation/CodingStyle''
 
* Both userspace or driver code shall use the Linux kernel "coding style". Details are given here: ''buildroot/output/build/linux-x.x/Documentation/CodingStyle''
* If not sure, one can use the following script to automagically indent its source files: ''buildroot/output/build/linux-2.6.35.3/scripts/Lindent''
+
* If not sure, one can use the following script to automagically indent its source files: ''buildroot/output/build/linux-x.x/scripts/Lindent''
  
 
==C++ files==
 
==C++ files==

Revision as of 08:49, 10 October 2012

This page defines the Coding Rules that apply to all the source code of the Armadeus Project BSP.

C files

  • Both userspace or driver code shall use the Linux kernel "coding style". Details are given here: buildroot/output/build/linux-x.x/Documentation/CodingStyle
  • If not sure, one can use the following script to automagically indent its source files: buildroot/output/build/linux-x.x/scripts/Lindent

C++ files

  • No rules defined yet.

Python files

  • No rules defined yet.

Makefiles

  • Makefiles syntax is already rigid enough to limit coder excentricity :-)
  • However: constants should be in Uppercase.

Bash scripts

  • Indentation: 1 TAB
  • Do not use more than 132 columns
  • Constants in Uppercase