github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-06-20 04:33:55 +00:00
Code Issues Projects Releases Wiki Activity

doc: add rules in C coding guidelines

Browse Source 
This patch adds rules in C coding guidelines.

Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
This commit is contained in:
Shiqing Gao 2019-04-30 10:09:53 +08:00 committed by David Kinder
parent b42d5c710c
commit 42a05c5f27
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1832,6 +1832,30 @@ Compliant example::
showcase_a++, showcase_b++; showcase_a++, showcase_b++;
C-EP-22: Magic numbers shall be used with restrictions
======================================================
Only the following cases shall be allowed:
a) The magic number is defined as a MACRO with a name clearly indicating its
meaning.
b) The meaning of the magic number is clearly documented in the comments before
its usage.
c) The meaning of the magic number is straightforward in the specific context.
Compliant example::
#define APIC_ID_MASK 0xff000000U
uint32_t showcase = APIC_ID_MASK;
.. rst-class:: non-compliant-code
Non-compliant example::
uint32_t showcase = 0xff000000U;
Types Types
***** *****