Misra Compliance updates (#38)

Modified MISRA.md/misra.config to reflect new style guidelines.
Added the DNDEBUG flag when performing the coverity_analysis build to remove assert

Co-authored-by: Soren Ptak <[email protected]>

Author: Skptak

MISRA.md

@@ -2,17 +2,15 @@
 
 The backoffAlgorithm 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:
+The specific deviations, suppressed inline, are listed below.
 
-### Ignored by [Coverity Configuration](tools/coverity/misra.config)
-| Deviation | Category | Justification |
-| :-: | :-: | :-: |
-| Directive 4.9 | Advisory | Allow inclusion of function like macros. |
-| Rule 3.1 | Required | Allow nested comments. C++ style `//` comments are used in example code within Doxygen documentation blocks. |
-| Rule 2.4 | Advisory | Allow unused tags. Some compilers warn if types are not tagged. |
+Additionally, [MISRA configuration file](https://github.com/FreeRTOS/backoffAlgorithm/blob/main/tools/coverity/misra.config) contains the project wide deviations.
 
-### Flagged by Coverity
-| Deviation | Category | Justification |
-| :-: | :-: | :-: |
-| 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
+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.4.2' . -rI
+```
+*None.*

lexicon.txt

@@ -22,6 +22,7 @@ getaddrinfo
 github
 html
 https
+ifdef
 ifndef
 inc
 ingroup
@@ -60,4 +61,3 @@ toolchain
 tr
 trng
 usleep
-utils

test/CMakeLists.txt

@@ -45,6 +45,9 @@ target_include_directories( coverity_analysis
                             PUBLIC
                              ${BACKOFF_ALGORITHM_INCLUDE_PUBLIC_DIRS} )
 
+# Disable logging/assert() calls when building the Coverity analysis target
+target_compile_options(coverity_analysis PUBLIC -DNDEBUG )
+
 #  ==================================== Unit Test Configuration ====================================
 
 if(${BUILD_CODE_EXAMPLE})

tools/coverity/misra.config

@@ -17,6 +17,10 @@
         {
             deviation: "Rule 3.1",
             reason: "Allow nested comments. Documentation blocks contain comments for example code."
-        }
+        },
+        {
+            deviation: "Rule 8.7",
+            reason: "API functions are not used by library. They must be externally visible in order to be used by the application."
+        },
     ]
 }