Skip to content

Commit bbae4cf

Browse files
Add MISRA doc containing all ignored violations (#20)
* Add MISRA doc containing all ignored violations * Remove unnecessary sentence * Italicize None. * Update MISRA.md to use its own config Co-authored-by: Muneeb Ahmed <[email protected]> Co-authored-by: Muneeb Ahmed <[email protected]>
1 parent d99b526 commit bbae4cf

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

MISRA.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
2+
# MISRA Compliance
3+
4+
The coreJSON library files conform to the [MISRA C:2012](https://www.misra.org.uk/MISRAHome/MISRAC2012/tabid/196/Default.aspx)
5+
guidelines, with some noted exceptions. Compliance is checked with Coverity static analysis.
6+
Deviations from the MISRA standard are listed below:
7+
8+
### Ignored by [Coverity Configuration](tools/coverity/misra.config)
9+
10+
| Deviation | Category | Justification |
11+
| :-: | :-: | :-: |
12+
| Directive 4.9 | Advisory | Allow inclusion of function like macros. |
13+
| Rule 3.1 | Required | Allow nested comments. C++ style `//` comments are used in example code within Doxygen documentation blocks. |
14+
| Rule 15.4 | Advisory | Allow more then one `break` statement to terminate a loop. |
15+
| Rule 19.2 | Advisory | Allow a `union` of a signed and unsigned type of identical sizes. |
16+
| Rule 20.12 | Required | Allow use of `assert()`, which uses a parameter in both expanded and raw forms. |
17+
18+
### Flagged by Coverity
19+
*None.*
20+
21+
### Suppressed with Coverity Comments
22+
*None.*

0 commit comments

Comments
 (0)