From a7350a2371838417e6ef75420fb0ae23c2d8c4e4 Mon Sep 17 00:00:00 2001 From: ZZ-Cat Date: Tue, 10 Sep 2024 10:19:11 +1200 Subject: [PATCH] docs(misra c compliance matrix): :memo: Add information on how each guideline is checked and where --- docs/misra_c_compliance_matrix.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/misra_c_compliance_matrix.md b/docs/misra_c_compliance_matrix.md index dea9e28b..8e1845ac 100644 --- a/docs/misra_c_compliance_matrix.md +++ b/docs/misra_c_compliance_matrix.md @@ -6,7 +6,13 @@ The [deviations](#deviations) section lists any deviations from the MISRA C guid ## Compliance -The following table is the MISRA C compliance matrix for CRSF for Arduino. +The following table is the MISRA C compliance matrix for CRSF for Arduino. +Each row corresponds to a MISRA C guideline, and each column corresponds to a tool or method used to ensure compliance with the guideline. +A checkmark :white_checkmark: in a cell indicates that the guideline is checked by the corresponding tool or method. +A cross :x: in a cell indicates that the guideline is not checked by the corresponding tool or method. + +If a cross is present in any column that corresponds to either the GCC Arm None EABI compiler or Cppcheck static analysis tool, this means that checking the guideline is not possible with that tool or method because it is not supported. +In this case, the guideline must be checked manually during code review, as indicated by a checkmark in the "Manual review" column. **Legend:**