Skip to content

Commit b90d8f4

Browse files
committed
readme update
1 parent 555d8f6 commit b90d8f4

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
11
# GTest MPI
2-
This project provides an extension to the Googletest framework, to allow the collection of errors on the root rank, when run with MPI.
2+
This project provides an extension to the Google Test framework, to allow testing of MPI enabled applications.
3+
The implementation includes a custom MPI environment and listener, with which all test failure messages are collected on the root process and the output includes the rank index for each failure.
34

45

56
## Requirements
6-
- Googltest version 1.8.1 (other versions may work as well, depending on changes to Listener or Environment interfaces)
7+
- Google Test version 1.8.1 (other versions may work as well, depending on changes to Listener or Environment interfaces)
78
- A MPI library
89
- At least C++ 11.
910
- Linux or macOS
1011

1112
## Limitations
12-
All ranks MUST execute all tests in the same order.
13+
- All ranks MUST execute all tests in the same order. Within a test, the executed assertions may differ. If a test should run only on a subset of ranks, the excluded ranks must enter the test, but may exit immediately.
14+
- Logging features of Google Test are not supported
15+
16+
1317

1418
## Example
1519
```

0 commit comments

Comments
 (0)