| Hugo L'Hostis | 8c7cb64 | 2021-04-22 12:12:05 +0100 | [diff] [blame^] | 1 | ######################### |
| 2 | Static Checking Framework |
| 3 | ######################### |
| 4 | |
| 5 | This tool has been made to provide a framework to check the truster-firmware-m |
| 6 | (TF-M) code base. |
| 7 | |
| 8 | ************ |
| 9 | Instructions |
| 10 | ************ |
| 11 | |
| 12 | This tool should be used from the root of the TF-M repository. launching |
| 13 | run_all_checks.sh will launch the different checkers used : |
| 14 | |
| 15 | - Cppcheck |
| 16 | - Copyright header check |
| 17 | - clang-format |
| 18 | |
| 19 | Each tool will be configured using a setup.sh script located under the tool |
| 20 | directory before being launched. The main script might need to be launched with |
| 21 | root priviledges in order to correctly install the tools on the first time it |
| 22 | is being used. |
| 23 | |
| 24 | The tool will return exit code of 0 if everything is compliant, and no |
| 25 | new warnings are generated, and 1 in all other occasions. |
| 26 | |
| 27 | Output reports if produced by each corresponding script, will be stored at |
| 28 | `{TFM-Root}/checks_reports`` |
| 29 | |
| 30 | -------------- |
| 31 | |
| 32 | *Copyright (c) 2021, Arm Limited. All rights reserved.* |
| 33 | *SPDX-License-Identifier: BSD-3-Clause* |