From c6e99acef81208ae679fe4234b6b35e111f91789 Mon Sep 17 00:00:00 2001 From: Egor Tensin Date: Wed, 7 Apr 2021 01:27:21 +0300 Subject: tools: update usage information, add docs/ entries --- tools/clang-format.py | 4 ++-- tools/ctest-driver.py | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) (limited to 'tools') diff --git a/tools/clang-format.py b/tools/clang-format.py index 01cdae5..81b2f93 100755 --- a/tools/clang-format.py +++ b/tools/clang-format.py @@ -5,9 +5,9 @@ # For details, see https://github.com/egor-tensin/cmake-common. # Distributed under the MIT License. -'''Feed C/C++ files in the repository to clang-format +'''clang-format all C/C++ files in the project -This script runs clang-format on every C/C++ file in the repository, either +This script feeds every C/C++ file in the repository to clang-format, either printing a unified diff between the original and the formatted versions, or formatting the files in-place. ''' diff --git a/tools/ctest-driver.py b/tools/ctest-driver.py index c5f9194..414e20c 100755 --- a/tools/ctest-driver.py +++ b/tools/ctest-driver.py @@ -5,12 +5,12 @@ # For details, see https://github.com/egor-tensin/cmake-common. # Distributed under the MIT License. -'''Wrap your actual test driver for CTest +'''Wrap your actual test driver to use with CTest CTest suffers from at least two issues, in particular with regard to its PASS_REGULAR_EXPRESSION feature: -1. The regular expression syntax is deficient. +1. The regular expression syntax used by CMake is deficient. 2. The exit code of a test is ignored if one of the regexes matches. This script tries to fix them. -- cgit v1.2.3