Skip to content

Commit 336b339

Browse files
Merge pull request #15 from bradleysmith23/main
Add MISRA.md
2 parents fe73897 + 52e6ec0 commit 336b339

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

MISRA.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# MISRA Compliance
2+
3+
The jobs library files conform to the [MISRA C:2012](https://www.misra.org.uk)
4+
guidelines, with some noted exceptions. Compliance is checked with Coverity static analysis.
5+
The specific deviations, suppressed inline, are listed below.
6+
7+
Additionally, [MISRA configuration file](https://github.com/aws/aws-iot-core-mqtt-file-streams-embedded-c/blob/main/tools/coverity/misra.config) contains the project wide deviations.
8+
9+
### Suppressed with Coverity Comments
10+
To find the violation references in the source files run grep on the source code
11+
with ( Assuming rule 11.4 violation; with justification in point 2 ):
12+
```
13+
grep 'MISRA Ref 11.1.4' . -rI
14+
```
15+
16+
MISRA Rule 21.6: use of snprintf to populate buffer
17+
18+
MISRA Rule 7.4: Assignment of string literal to const uint8_t *

0 commit comments

Comments
 (0)