tools/readme.md: short description of astyle-client

This commit is contained in:
Daniel Marjamäki 2019-06-30 19:20:29 +02:00
parent daa770a5ee
commit c0b06fbce9
1 changed files with 16 additions and 0 deletions

View File

@ -1,5 +1,19 @@
## Cppcheck developer and build tools
##¤ * tools/astyle-client.py
With this tool you can astyle-format arbitrary cpp/header files even if you do not have astyle on your computer.
astyle on a server is used.
Example usage:
python tools/astyle-client.py lib/token.cpp
The file is reformatted and a status message is written that says if there were any changes or not.
This script is a lot slower than running astyle locally on your computer.
### * tools/matchcompiler.py
The matchcompiler.py is a build script that performs a few code transformations to *.cpp* files under the *lib* directory. These transformations are related to the use of `Token::Match()` function and are intended to improve code performance. The transformed files are saved on the *build* directory. This tool is silently used when building the code with `SRCDIR=build`, that is:
@ -64,3 +78,5 @@ Script that reduces code for a hang/false positive.
### * tools/times.sh
Script to generate a `times.log` file that contains timing information of the last 20 revisions.