labplot/admin/README.clang-tidy

0001 http://clang.llvm.org/extra/clang-tidy/
0002
0003 To use clang-tidy:
0004 * add -DCMAKE_EXPORT_COMPILE_COMMANDS=ON to cmake (for example in compile-clang)
0005 * cd src && ln -s ../build-clang/compile_commands.json compile_commands.json
0006 * execute clang-tidy
0007
0008
0009 To list all available checks:
0010 * clang-tidy --list-checks -checks='*' | grep "modernize"
0011
0012 E.g., use override for virtual funcsion:
0013 * clang-tidy my_file.cpp -checks='modernize-use-override'
0014
0015 clan-tidy can also execute clang-analyzer checks, e.g.
0016 * clang-tidy my_file.cpp -checks=-*,clang-analyzer-*,-clang-analyzer-cplusplus*
0017
0018 To apply the fixes direcly on the file, add 'fix' parameter:
0019 * clang-tidy.py my_file.cpp -header-filter='.*' -checks='-*,modernize-use-nullptr' -fix
0020
0021 To apply clang-tidy to many files, use the run-clang-tidy.py script in this folder (current version under run-clang-tidy.py -header-filter='.*' -checks='-*,modernize-use-nullptr' -fix), execute in src/:
0022 * python3 ../admin/run-clang-tidy.py backend/ -header-filter='.*' -checks='-*,modernize-use-override' -fix
0023 * python3 ../admin/run-clang-tidy.py backend/ -header-filter='.*' -checks='-*,modernize-use-nullptr' -fix
0024 * etc.