| Build Status | |
|---|---|
| Travis |  |
Example CMake project that incorporates awesome Clang tooling.
Current status: Work in progress.
$ sudo apt install gcc g++ clang clang-tidy cmake cppcheck doxygen graphvizUse -DCMAKE_BUILD_TYPE=Release or -DCMAKE_BUILD_TYPE=Debug to specify release or debug builds.
$ cd build
$ cmake ..
$ make$ cd build
$ cmake -DCMAKE_CXX_COMPILER=clang++ ..
$ makeNavigate into the build directory.
$ ./clang-blueprint$ ./unit-test$ cd docs
$ doxygen
$ firefox html/index.htmlNavigate into the build directory.
Clang-Tidy is configured using the .clang-format configuration file. Modify
this file to control which checks should be run and configure parameters for certain checks.
$ cmake ..
$ make clang-tidy
Scanning dependencies of target clang-tidy
95 warnings generated.
7477 warnings generated.
/home/user/GitHub/clang-blueprint/src/main.cpp:10:28: warning: parameter 'argc' is unused [misc-unused-parameters]
int32_t main(const int32_t argc, const char* argv[]) {
^~~~~
/*argc*/
/home/user/GitHub/clang-blueprint/src/main.
...Clang-Format is configured using the .clang-format configuration file. Modify this file to control how source files should be formatted.
To demonstrate clang-format in action, first modify src/main.cpp from
return EXIT_SUCCESS;To
return EXIT_SUCCESS;Next, run clang-format on the project.
$ cmake ..
$ make clang-formatmain.cpp will be reformatted properly to
return EXIT_SUCCESS;To run Cppcheck on the project
$ cmake ..
$ make cppcheck
[/home/user/GitHub/clang-blueprint/src/main.cpp:14]: (error) Array 'a[2]' accessed at index 3, which is out of bounds.
...