From 168177b7c8167fdab1548a21f4226d27338e39b2 Mon Sep 17 00:00:00 2001 From: bradleysmith23 Date: Thu, 16 Nov 2023 14:55:25 -0800 Subject: [PATCH 1/2] Add MISRA.md --- MISRA.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 MISRA.md diff --git a/MISRA.md b/MISRA.md new file mode 100644 index 0000000..65b8af2 --- /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/Jobs-for-AWS-IoT-embedded-sdk/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 From 3e38b5bf202c97d9473908647c864edb335bee57 Mon Sep 17 00:00:00 2001 From: bradleysmith23 Date: Thu, 16 Nov 2023 14:58:54 -0800 Subject: [PATCH 2/2] Update link in MISRA.md --- MISRA.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/MISRA.md b/MISRA.md index 65b8af2..ab2175f 100644 --- a/MISRA.md +++ b/MISRA.md @@ -4,7 +4,7 @@ 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/Jobs-for-AWS-IoT-embedded-sdk/blob/main/tools/coverity/misra.config) contains the project wide deviations. +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