| Hugo L'Hostis | 8c7cb64 | 2021-04-22 12:12:05 +0100 | [diff] [blame] | 1 | ######## |
| 2 | Cppcheck |
| 3 | ######## |
| 4 | cppcheck is a tool used to check a number of checks on the codebase. The list |
| 5 | of all the checks is available at : |
| 6 | https://sourceforge.net/p/cppcheck/wiki/ListOfChecks/ |
| 7 | |
| 8 | ****************** |
| 9 | tool configuration |
| 10 | ****************** |
| 11 | |
| 12 | This tool is using the pre-existing cppcheck configurations |
| 13 | (arm-cortex-m.cfg/tfm-suppress-list.txt), implementing the developer's |
| 14 | guidelines, as used by the TF-M CI. |
| 15 | |
| 16 | The suppression list contains: |
| 17 | |
| 18 | - Files that are not guaranteed to comply with the TF-M rules. |
| 19 | - Files under directories that correspond to external libraries. |
| 20 | |
| 21 | The files utils.sh, arm-cortex-cfg.cfg and tfm-suppress-list.txt were copied |
| 22 | from the CI scripts repo : |
| 23 | https://review.trustedfirmware.org/admin/repos/ci/tf-m-ci-scripts |
| 24 | |
| 25 | *************** |
| 26 | Using this tool |
| 27 | *************** |
| 28 | |
| 29 | This script must be launched from the TFM repo and the reports will be stored |
| 30 | under checks_reports if the xml option is selected. The possible parameters are |
| 31 | the following: |
| 32 | |
| 33 | - '-h' display the help for this tool |
| 34 | - '-r' select the raw output option. If this parameter is selected, the |
| 35 | output will be displayed in the console instead of stored in an xml file |
| 36 | |
| 37 | |
| 38 | |
| 39 | -------------- |
| 40 | |
| 41 | *Copyright (c) 2021, Arm Limited. All rights reserved.* |
| 42 | *SPDX-License-Identifier: BSD-3-Clause* |