diff --git a/doc/code_rules.md b/doc/code_rules.md index 5ce1165ab993aa2384f276a95a27e172e3179d1d..f88d808c42170b251717b419265af4c8c87ce01d 100644 --- a/doc/code_rules.md +++ b/doc/code_rules.md @@ -35,15 +35,16 @@ To invoke `cppcheck` manually, use: cppcheck --xml \ --enable=all \ --force \ - --library=\"${WORKDIR}/arm-cortex-m.cfg\" \ - --suppressions-list=\"suppress-list.txt" \ - --includes-file=\"${PROJECT_DIRECTORIES_FILE}\" \ - -I \"${WORKDIR}/CMSIS\" \ + --suppressions-list="${WORKDIR}/tools/cppcheck_suppress_list.txt" \ + --includes-file="${WORKDIR}/framework/include/" \ + -I "${WORKDIR}/CMSIS" \ + -i cmsis \ -U__CSMC__ \ - ." + ${WORKDIR} \endcode -The CMSIS submodule is not checked. +The CMSIS submodule is not checked. Errors are printed in XML format on the +error output. Certain checks have been manually suppressed. Checks are generally only disabled if they have been triaged as false positives. The list of suppressed