aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/clang-format.md5
-rw-r--r--docs/ctest-driver.md13
2 files changed, 18 insertions, 0 deletions
diff --git a/docs/clang-format.md b/docs/clang-format.md
new file mode 100644
index 0000000..217b2da
--- /dev/null
+++ b/docs/clang-format.md
@@ -0,0 +1,5 @@
+`clang-format` all C/C++ files in the project.
+
+ $ cd project/
+ $ python3 path/to/tools/clang-format.py # Prints a diff
+ $ python3 path/to/tools/clang-format.py -i # Edits files in-place
diff --git a/docs/ctest-driver.md b/docs/ctest-driver.md
new file mode 100644
index 0000000..af7c3b2
--- /dev/null
+++ b/docs/ctest-driver.md
@@ -0,0 +1,13 @@
+CTest suffers from at least two issues, in particular with regard to its
+PASS_REGULAR_EXPRESSION feature:
+
+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.
+
+`ctest-driver.py` tries to fix them.
+
+ $ python3 path/to/tools/ctest-driver.py run --pass-regex OK --fail-regex Fail -- path/to/executable arg1 arg2
+
+In addition, it's a cross-platform `grep`:
+
+ $ python3 path/to/tools/ctest-driver.py grep --pass-regex OK --fail-regex Fail -- path/to/logfile.log