24 lines
1.4 KiB
Markdown
24 lines
1.4 KiB
Markdown
# MISRA Compliance
|
|
|
|
The Device Defender Client Library files conform to the
|
|
[MISRA C:2012](https://www.misra.org.uk)
|
|
guidelines, with some noted exceptions. Compliance is checked with Coverity static analysis.
|
|
Deviations from the MISRA standard are listed below:
|
|
|
|
### Ignored by [Coverity Configuration](tools/coverity/misra.config)
|
|
| Deviation | Category | Justification |
|
|
| :-: | :-: | :-: |
|
|
| Directive 4.9 | Advisory | Allow inclusion of function like macros. The `assert` macro is used throughout the library for parameter validation, and logging is done using function like macros. |
|
|
| Rule 3.1 | Required | Allow nested comments. C++ style `//` comments are used in example code within Doxygen documentation blocks. |
|
|
| Rule 12.3 | Advisory | Allow use of `assert` macro, expansion of which uses comma operator. |
|
|
| Rule 15.6 | Required | Allow use of `assert` macro, expansion of which contains non-compound if statements. |
|
|
| Rule 20.12 | Required | Allow use of `assert` macro, which uses a parameter in both expanded and raw forms. |
|
|
|
|
### Flagged by Coverity
|
|
| Deviation | Category | Justification |
|
|
| :-: | :-: | :-: |
|
|
| Rule 2.5 | Advisory | Macros defined for keys in the defender report are not used by the library; however, they are needed to be used by an application. |
|
|
| Rule 8.7 | Advisory | API functions are not used by the library; however, they must be externally visible in order to be used by an application. |
|
|
|
|
### Suppressed with Coverity Comments
|
|
*None.* |