github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-08-09 12:08:30 +00:00
Code Issues Projects Releases Wiki Activity

doc: update coding guidelines

Browse Source 
- add a rule for function parameter limit

Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
This commit is contained in:
Shiqing Gao 2020-10-30 15:30:47 +08:00 committed by David Kinder
parent 62d0088565
commit 76017ec67f
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/developer-guides/c_coding_guidelines.rst
View File

@ -1079,6 +1079,26 @@ Compliant example::
} }
C-FN-20: Each function shall have at most 6 parameters
======================================================
Compliant example::
void func_showcase(uint32_t param_1, uint32_t param_2, uint32_t param_3,
uint32_t param_4, uint32_t param_5, uint32_t param_6) {
...
}
.. rst-class:: non-compliant-code
Non-compliant example::
void func_showcase(uint32_t param_1, uint32_t param_2, uint32_t param_3,
uint32_t param_4, uint32_t param_5, uint32_t param_6,
uint32_t param_7) {
...
}
Statements Statements
********** **********