Difference between revisions of "Coding Rules"
From ArmadeusWiki
m (→C files) |
|||
| Line 6: | Line 6: | ||
==C++ files== | ==C++ files== | ||
| − | * | + | * 2 possibilities: |
| + | ** either comply with the "C files" Conding Rules listed just above or, | ||
| + | ** follow the [http://qt-project.org/wiki/Qt_Coding_Style Qt Coding Style.] | ||
==Python files== | ==Python files== | ||
| Line 16: | Line 18: | ||
==Bash scripts== | ==Bash scripts== | ||
| − | * Indentation: 1 | + | * Indentation: 1 Tabulation, |
| − | * Do not use more than 132 columns | + | * Do not use more than 132 columns, |
| − | * Constants in Uppercase | + | * Constants in Uppercase. |
| + | |||
| + | ==Licences== | ||
| + | * Armadeus Project only accept sources that comply with the major Licenses available in the Free Software community: GPL, GPLv2, LGPL or BSD. | ||
Revision as of 17:02, 14 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
- 2 possibilities:
- either comply with the "C files" Conding Rules listed just above or,
- follow the Qt Coding Style.
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 Tabulation,
- Do not use more than 132 columns,
- Constants in Uppercase.
Licences
- Armadeus Project only accept sources that comply with the major Licenses available in the Free Software community: GPL, GPLv2, LGPL or BSD.
