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

doc: add rules related to implementation-specific behaviors

Browse Source 
This patch adds some rules related to implementation-specific
behaviors.

Tracked-On: #861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
This commit is contained in:
Shiqing Gao
2019-03-15 10:51:06 +08:00
committed by David Kinder
parent e131d7059a
commit 90b49375e4
1 changed files with 57 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
doc/developer-guides/coding_guidelines.rst
View File

@@ -2665,8 +2665,8 @@ ID-07: Name defined by developers shall not start with underscore
================================================================= =================================================================
All names starting with one or two underscores are reserved for use by the All names starting with one or two underscores are reserved for use by the
compiler and standard libraries to eliminate potential conflicts with user- compiler and standard libraries to eliminate potential conflicts with
defined names. user-defined names.
Compliant example:: Compliant example::
@@ -3255,3 +3255,58 @@ Compliant example::
}; };
Implementation-specific Behaviors
*********************************
IB-01: All characters in an identifier are significant initial characters
=========================================================================
The number of significant initial characters in an identifier is
implementation-defined, according to J.3.3 item 2 in C99. For ACRN hypervisor,
all characters in an identifier are significant initial characters.
IB-02: The number of bits in a byte is 8
========================================
The number of bits in a byte is implementation-defined, according to J.3.4 item
1 in C99. For ACRN hypervisor, the number of bits in a byte is 8.
IB-03: The values of the members of the execution character set depends on ASCII Table
======================================================================================
The values of the members of the execution character set is
implementation-defined, according to J.3.4 item 2 in C99. For ACRN hypervisor,
characters are encoded in ASCII. This rule applies to the source code that is
being compiled. Non-ASCII characters are allowed in comments, such as the author
name.
IB-04: 'plain' char is equivalent to signed char
=================================================
The underlying type of 'plain' char is implementation-defined, according to
J.3.4 item 5 in C99. For ACRN hypervisor, 'plain' char is equivalent to signed
char.
IB-05: Signed integers are represented in two's complement
==========================================================
Whether signed integer types are represented using sign and magnitude, two's
complement, or ones' complement is implementation-defined, according to J.3.5
item 2 in C99. For ACRN hypervisor, signed integers are represented in two's
complement.
IB-06: The integer type compatible with each enumerated type is case by case
============================================================================
The integer type compatible with each enumerated type is implementation-defined,
according to J.3.9 item 6 in C99. For ACRN hypervisor, if the enum has no
negative underlying values, unsigned int is used; otherwise, int is used.
IB-07: The number of bytes in an object is specified
====================================================
The number of bytes in an object is implementation-defined, according to J.3.13
item 2 in C99. For ACRN hypervisor, char is 1 byte, short is 2 bytes, int is 4
bytes, long is 8 bytes, and long long is not used.