proxmox-mirrors/mirror_lxc
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_lxc synced 2025-07-30 23:20:10 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

CODING_STYLE: clang-format

Browse Source 
Signed-off-by: Christian Brauner <christian.brauner@ubuntu.com>
This commit is contained in:
Christian Brauner 2018-03-02 12:29:30 +01:00
parent 0c9119fc1f
commit c67cb61950
No known key found for this signature in database
GPG Key ID: 8EB056D53EECB12D
1 changed files with 44 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
CODING_STYLE.md
View File

@ -16,6 +16,50 @@
style and add their Signed-off-by line to it. This is especially helpful to style and add their Signed-off-by line to it. This is especially helpful to
make it easier for first-time contributors and to prevent having pull make it easier for first-time contributors and to prevent having pull
requests being stuck in the merge queue because of minor details. requests being stuck in the merge queue because of minor details.
- We currently do not provide automatic coding style checks but if a suitable
tool is found we are happy to integrate it into our test suite. It is
possible and recommended to use the `clang-format` binary to check your code.
The following options are an approximation of the coding style used here.
Simply create a file called `.clang-format` in your home directory with the
following options:
```sh
cat << EOF > "${HOME}"/.clang-format
BreakBeforeBraces: Attach
AlwaysBreakBeforeMultilineStrings: false
BreakBeforeBinaryOperators: None
MaxEmptyLinesToKeep: 1
PenaltyBreakBeforeFirstCallParameter: 1000000
BinPackArguments: true
BinPackParameters: true
AllowAllParametersOfDeclarationOnNextLine: false
AlignAfterOpenBracket: true
SpacesInSquareBrackets: false
SpacesInCStyleCastParentheses: false
SpaceInEmptyParentheses: false
SpaceBeforeParens: ControlStatements
SpaceAfterCStyleCast: false
SortIncludes: true
PenaltyReturnTypeOnItsOwnLine: 10000
PenaltyExcessCharacter: 10
Language: Cpp
ForEachMacros: ['lxc_list_for_each', 'lxc_list_for_each_safe']
AllowShortLoopsOnASingleLine: false
AllowShortIfStatementsOnASingleLine: false
AllowShortFunctionsOnASingleLine: None
AllowShortCaseLabelsOnASingleLine: false
AllowShortBlocksOnASingleLine: false
BasedOnStyle: LLVM
TabWidth: 8
IndentWidth: 8
UseTab: Always
BreakBeforeBraces: Linux
AllowShortIfStatementsOnASingleLine: false
IndentCaseLabels: false
EOF
```
However, it will not handle all cases correctly. For example, most `struct`
initializations will not be correct. In such cases please refer to the coding
style here.
#### Only Use Tabs #### Only Use Tabs