Skip to content

Commit 7cdd083

Browse files
mkrainiukdnhsieh-intel
authored andcommitted
[Docs] add link to unit test readme and use correct github team names for maintainers (#520)
Co-authored-by: Dai-Ni Hsieh <[email protected]>
1 parent 989578c commit 7cdd083

File tree

4 files changed

+25
-43
lines changed

4 files changed

+25
-43
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -320,6 +320,6 @@ for (int i = 0; i < loop_size; i++) ...;
320320

321321
## Unit Tests
322322

323-
oneMKL uses GoogleTest for functional testing.
323+
oneMKL uses GoogleTest for functional testing. For more information about how to build and run Unit Tests please see [Building and Running Tests](https://oneapi-src.github.io/oneMKL/building_and_running_tests.html).
324324

325325
Be sure to extend the existing tests when fixing an issue, adding a new interface or new implementation under existing interfaces.

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -549,14 +549,14 @@ For GitHub questions, issues, RFCs, or PRs you can contact maintainers via one o
549549

550550
| GitHub team name | Description |
551551
:-----------|:------------|
552-
| [oneMKL-maintain](https://github.com/orgs/oneapi-src/teams/onemkl-maintain) | All oneMKL maintainers |
553-
| [oneMKL-arch-write](https://github.com/orgs/oneapi-src/teams/onemkl-arch-write) | oneMKL Architecture maintainers |
554-
| [oneMKL-blas-write](https://github.com/orgs/oneapi-src/teams/onemkl-blas-write) | oneMKL BLAS maintainers |
555-
| [oneMKL-dft-write](https://github.com/orgs/oneapi-src/teams/onemkl-dft-write) | oneMKL DFT maintainers |
556-
| [oneMKL-lapack-write](https://github.com/orgs/oneapi-src/teams/onemkl-lapack-write) | oneMKL LAPACK maintainers |
557-
| [oneMKL-rng-write](https://github.com/orgs/oneapi-src/teams/onemkl-rng-write) | oneMKL RNG maintainers |
558-
| [oneMKL-sparse-write](https://github.com/orgs/oneapi-src/teams/onemkl-sparse-write) | oneMKL Sparse Algebra maintainers |
559-
| [oneMKL-vm-write](https://github.com/orgs/oneapi-src/teams/onemkl-vm-write) | oneMKL Vector Math maintainers |
552+
| @oneapi-src/onemkl-maintain | All oneMKL maintainers |
553+
| @oneapi-src/onemkl-arch-write | oneMKL Architecture maintainers |
554+
| @oneapi-src/onemkl-blas-write | oneMKL BLAS maintainers |
555+
| @oneapi-src/onemkl-dft-write | oneMKL DFT maintainers |
556+
| @oneapi-src/onemkl-lapack-write) | oneMKL LAPACK maintainers |
557+
| @oneapi-src/onemkl-rng-write | oneMKL RNG maintainers |
558+
| @oneapi-src/onemkl-sparse-write | oneMKL Sparse Algebra maintainers |
559+
| @oneapi-src/onemkl-vm-write | oneMKL Vector Math maintainers |
560560

561561
---
562562

docs/building_and_running_tests.rst

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,20 @@ following:
3131
and then used in oneMKL by setting ``-REF_BLAS_ROOT=/path/to/lapack/install``
3232
and ``-DREF_LAPACK_ROOT=/path/to/lapack/install``.
3333

34-
To run the tests, either use the CMake test driver, by running ``ctest``, or run
35-
individual test binaries individually.
34+
You can re-run tests without re-building the entire project.
35+
36+
To run the tests, either run test binaries individually, or use ``ctest`` CMake test driver program.
37+
38+
.. code-block:: bash
39+
40+
# Run all tests
41+
ctest
42+
# Run only Gpu specific tests
43+
ctest -R Gpu
44+
# Exclude Cpu tests
45+
ctest -E Cpu
46+
47+
For more ``ctest`` options, refer to `ctest manual page <https://cmake.org/cmake/help/v3.13/manual/ctest.1.html>`_.
3648

3749
When running tests you may encounter the issue ``BACKEND NOT FOUND EXCEPTION``,
3850
you may need to add your ``<oneMKL build directory>/lib`` to your

tests/README.md

Lines changed: 2 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -3,39 +3,9 @@
33
## Overview
44
Inside the `unit_tests` directory, there are domain-level directories which contain domain-specific tests, usually per function or per configuration.
55

6-
## Steps
7-
Functional testing is enabled by default, so all relevant functional tests will run automatically after the project is built successfully.
6+
See [Building and Running Tests](https://oneapi-src.github.io/oneMKL/building_and_running_tests.html) documentation for more information about how to build and run the tests.
87

9-
*Note: A set of `build options` define a `build configuration`. `CMake` builds and runs different set of tests depending on your `build configuration`. This is because `CMake` generates an export header file (config.hpp) for the selected build configuration. Check `<path to onemkl>/src/config.hpp.in` and `<path to onemkl>/src/CMakeLists.txt` for details. For details on how `CMake` performs export header generation, refer to [CMake documentation](https://cmake.org/cmake/help/v3.13/module/GenerateExportHeader.html).*
10-
11-
You can re-run tests without re-building the entire project.
12-
13-
#### The `CMake` Approach Works for any Generator
14-
```bash
15-
cmake --build . --target test
16-
```
17-
18-
#### To use Generator-specific Commands:
19-
20-
```bash
21-
# For ninja
22-
ninja test
23-
```
24-
25-
```bash
26-
# For GNU Makefiles
27-
ctest
28-
# Test filter use case - runs only Gpu specific tests
29-
ctest -R Gpu
30-
# Exclude filtering use case - excludes Cpu tests
31-
ctest -E Cpu
32-
```
33-
34-
For more `ctest` options, refer to [ctest manual page](https://cmake.org/cmake/help/v3.13/manual/ctest.1.html).
35-
36-
## BLAS
37-
38-
The tests in the level\<x> directories are for the corresponding level\<x> BLAS routines. [GoogleTest](https://github.com/google/googletest) is used as the unit-testing framework.
8+
[GoogleTest](https://github.com/google/googletest) is used as the unit-testing framework.
399

4010

4111
*Refer to `<path to onemkl>/deps/googletest/LICENSE` for GoogleTest license.*

0 commit comments

Comments
 (0)