Skip to content

Commit

Permalink
docs(misra c compliance matrix): 📝 Add information on how each guidel…
Browse files Browse the repository at this point in the history
…ine is checked and where
  • Loading branch information
ZZ-Cat committed Sep 9, 2024
1 parent 08cd5e7 commit a7350a2
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/misra_c_compliance_matrix.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:**

Expand Down

0 comments on commit a7350a2

Please sign in to comment.