diff --git a/MISRA.md b/MISRA.md new file mode 100644 index 0000000..ab2175f --- /dev/null +++ b/MISRA.md @@ -0,0 +1,18 @@ +# MISRA Compliance + +The jobs 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. +The specific deviations, suppressed inline, are listed below. + +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. + +### Suppressed with Coverity Comments +To find the violation references in the source files run grep on the source code +with ( Assuming rule 11.4 violation; with justification in point 2 ): +``` +grep 'MISRA Ref 11.1.4' . -rI +``` + +MISRA Rule 21.6: use of snprintf to populate buffer + +MISRA Rule 7.4: Assignment of string literal to const uint8_t * \ No newline at end of file