@@ -53,8 +53,8 @@ repository before adding it as a submodule to your other projects.
5353
5454### cxxdt-cmake-lint
5555
56- Check if the format of the specified CXX files is compliant with the CXX style
57- configuration defined in this repo .
56+ Checks if the format of the specified CMake files is compliant with the CMake
57+ style configuration defined in this repository ( ` cmake/config ` ) .
5858
5959``` bash
6060$ cxxdt-cmake-lint test/cmake-lint/samples/invalid-format.cmake
@@ -105,42 +105,30 @@ $ echo $?
1051050
106106```
107107
108+ ## cxxdt-cmake-format
108109
110+ Formats the specified CMake files using the CMake style configuration defined
111+ in this repository. The CML interface is the same as ` cxxdt-cmake-lint ` .
109112
113+ ## cxxdt-cxx-lint
110114
111- ## Continuous Integration
112-
113- Add cxx-dev-tools to your CI configuration if you want to test that the files
114- committed comply with the unique formating defined here (or your own format if
115- you have fork and modify this repo, see above). See ` .circleci/config.yml ` for
116- an example on how to check that the format of your CXX and CMake files pass.
117-
118- ## Tools
115+ Checks if the format of the specified CXX files is compliant with the CXX
116+ style configuration defined in this repository (` cxx/config ` ).
117+ The CML interface is the same as ` cxxdt-cmake-lint ` .
119118
120- ### Linters and format validators
119+ ## cxxdt-cxx- format
121120
122- TODO: List the wrappers instead
121+ Formats the specified CXX files using the CXX style configuration defined
122+ in this repository. The CML interface is the same as ` cxxdt-cmake-lint ` .
123123
124- - [ cmake-format] ( https://github.com/cheshirekow/cmake_format.git ) :
125- Linter and format validator for CMake files (CMakeLists.txt, .cmake, etc.)
126- - [ clang-format] ( https://github.com/llvm-mirror/clang/tree/master/tools/clang-format ) :
127- Linter and format validator for CXX files (.hpp, .cpp, .h, .cpp, etc.)
124+ ## GitHub tools
128125
129- ### CMake tools
126+ ### GitHub hooks
130127
131- - [ BuildType.cmake ] ( cmake/BuildType.cmake ) : Set a default build type if none
132- was specified .
128+ - [ pre-commit hook ] ( git/.githooks/pre-commit ) - Checks
129+ that your ` .circleci/config.yml ` is valid, otherwise ` git commit ` fails .
133130
134- ### GitHub tools
135-
136- - [ pre-commit hook] ( git/.githooks/pre-commit ) : This example git pre hook checks
137- that your ` .circleci/config.yml ` is valid, otherwise ` git commit ` will fail.
138-
139- ## Configurations
140-
141- This repo includes the following configuration files.
131+ ## Continuous Integration
142132
143- - [ cmake/format/.cmake-format.json] ( cmake/format/.cmake-format.json ) :
144- Default configuration file for ` cmake-format ` .
145- - [ cmake/format/.esp-idf-cmake-format.json] ( cmake/format/.esp-idf-cmake-format.json ) :
146- Configuration file for ` cmake-format ` for ESP-IDF projects.
133+ An example of integration of ` cxx-dev-tools ` into a CI configuration is
134+ available in ` .circleci/config.yml ` .
0 commit comments