xaymar/cmake-clang
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Michael Fabian Dirks
2020-04-19 02:32:56 +02:00
committed by GitHub
parent 262bd283bf
commit cf52adf62a
1 changed files with 23 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+23
View File
@@ -32,3 +32,26 @@ Add a `TARGETNAME_CLANG-TIDY` target to the project which runs clang-tidy on the
* `REGEX <filter>`: Specify a regular expression by which to filter all sources of the given targets. Defaults to `\.(h|hpp|c|cpp)$`. * `REGEX <filter>`: Specify a regular expression by which to filter all sources of the given targets. Defaults to `\.(h|hpp|c|cpp)$`.
* `VERSION <version>`: Require a minimum Clang Toolset version to run clang-tidy. * `VERSION <version>`: Require a minimum Clang Toolset version to run clang-tidy.
* `TARGETS <target>[;<target>[;...]]`: Specify on which targets clang-tidy is supposed to be run. * `TARGETS <target>[;<target>[;...]]`: Specify on which targets clang-tidy is supposed to be run.
# Example Usage
## Adding clang-format as a dependency and clang-tidy as a normal target
```
if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/cmake/Clang/Clang.cmake")
include("Clang")
option(ENABLE_CLANG ON)
if(ENABLE_CLANG)
generate_compile_commands_json(
TARGETS ${PROJECT_NAME}
)
clang_tidy(
TARGETS ${PROJECT_NAME}
VERSION 9.0.0
)
clang_format(
TARGETS ${PROJECT_NAME}
DEPENDENCY
VERSION 9.0.0
)
endif()
endif()
```