From c0b06fbce9811aba7146da1e1bfbff5ba1d1f694 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Marjam=C3=A4ki?= Date: Sun, 30 Jun 2019 19:20:29 +0200 Subject: [PATCH] tools/readme.md: short description of astyle-client --- tools/readme.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/tools/readme.md b/tools/readme.md index e49a92a5e..c57f83dd9 100644 --- a/tools/readme.md +++ b/tools/readme.md @@ -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. + +