summaryrefslogtreecommitdiffstatshomepage
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/ctest-driver.md7
-rw-r--r--docs/project-clang-format.md6
2 files changed, 8 insertions, 5 deletions
diff --git a/docs/ctest-driver.md b/docs/ctest-driver.md
index e196a36..3f3f2a5 100644
--- a/docs/ctest-driver.md
+++ b/docs/ctest-driver.md
@@ -4,10 +4,11 @@ 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.
+`project-ctest-driver` (alternatively, `python -m project.ctest_driver`) tries
+to fix them.
- $ python path/to/tools/ctest-driver.py run --pass-regex OK --fail-regex Fail -- path/to/executable arg1 arg2
+ $ project-ctest-driver run --pass-regex OK --fail-regex Fail -- path/to/executable arg1 arg2
In addition, it's a cross-platform `grep`:
- $ python path/to/tools/ctest-driver.py grep --pass-regex OK --fail-regex Fail -- path/to/logfile.log
+ $ project-ctest-driver grep --pass-regex OK --fail-regex Fail -- path/to/logfile.log
diff --git a/docs/project-clang-format.md b/docs/project-clang-format.md
index 1beeced..821ad9f 100644
--- a/docs/project-clang-format.md
+++ b/docs/project-clang-format.md
@@ -1,5 +1,7 @@
`clang-format` all C/C++ files in the project.
$ cd project/
- $ python path/to/tools/project-clang-format.py # Prints a diff
- $ python path/to/tools/project-clang-format.py -i # Edits files in-place
+ $ project-format # Prints a diff
+ $ project-format -i # Edits files in-place
+
+Alternatively, run it as a Python module: `python -m project.format`