Skip to content

Commit 4e4fef8

Browse files
committed
update docs
1 parent a27d490 commit 4e4fef8

File tree

2 files changed

+20
-10
lines changed

2 files changed

+20
-10
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -178,17 +178,20 @@ the need to store large test vector files in git, and instead can be generated a
178178

179179
To run the unit tests, from the cmake build directory run:
180180
```sh
181-
test/matx_test
181+
make -j test
182182
```
183183

184-
This will execute all unit tests defined. If you wish to execute a subset of tests, or run with different options, you
185-
may run test/matx_test directly with parameters defined by [Google Test](https://github.com/google/googletest). To run matx_test
186-
directly, you must be inside the build/test directory for the correct paths to be set. For example,
187-
to run only tests with the name FFT:
184+
This will execute all unit tests defined. It is also possible to build and execute a single test, for example:
185+
```
186+
make test_00_operators_interp_test
187+
test/test_00_operators_interp_test
188+
```
189+
190+
To run a subset of tests, it is possible to use [ctest](https://cmake.org/cmake/help/latest/manual/ctest.1.html) from inside the `build/test` directory. For example, to run only tests with the name FFT:
188191

189192
```sh
190193
cd build/test
191-
./matx_test --gtest_filter="*FFT*"
194+
ctest -R "FFT"
192195
```
193196

194197

docs/_sources/basics/build.rst

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,13 +88,20 @@ To build unit tests, pass the argument ``-DMATX_BUILD_TESTS=ON`` to CMake to con
8888
8989
make -j test
9090
91-
This will compile and run all unit tests. For more control over which tests to run, you may run test/matx_test directly with parameters
92-
defined by Google Test (https://github.com/google/googletest). To run matx_test directly, you must be inside the build/test directory
93-
for the correct paths to be set. For example, to run only tests with the name FFT:
91+
This will execute all unit tests defined. It is also possible to build and execute a single test, for example:
9492

9593
.. code-block:: shell
9694
97-
test/matx_test --gtest_filter="*FFT*"
95+
make test_00_operators_interp_test
96+
test/test_00_operators_interp_test
97+
98+
To run a subset of tests, it is possible to use `ctest <https://cmake.org/cmake/help/latest/manual/ctest.1.html>`_ from inside the ``build/test`` directory. For example, to run only tests with the name FFT:
99+
100+
.. code-block:: shell
101+
102+
cd build/test
103+
ctest -R "FFT"
104+
98105
99106
Examples
100107
--------

0 commit comments

Comments
 (0)