Skip to content

Commit 495ef1c

Browse files
authored
Update README.md
1 parent f316c79 commit 495ef1c

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

tools/verifyio/README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,22 @@ Dependencies: `recorder-viz` and `networkx`. Both can be installed using pip.
1111
Steps:
1212
1. Run program with Recorder to generate traces.
1313
2. Run the conflict detector to report **potential** conflicting I/O accesses.
14-
Those acesses are only potentially conflicting as here we do not take MPI communication into consideration yet.
14+
Those acesses are only potentially conflicting as here we do not take happens-before order into consideration yet.
1515

1616
`$RECORDER_DIR/bin/conflict_detector /path/to/traces --semantics=posix`
1717

18-
This command will write all conflicts found to the file `/path/to/traces/conflicts.txt`
18+
The `semantics` option needs to match the one provided by the underlying file system. For example, if the traces were collected on UnifyFS, set it to "commit".
1919

20-
3. Finally run the verification code, which checks if those conflicting operations are properly synchronzied.
20+
This command will write all potential conflicts found to the file `/path/to/traces/conflicts.txt`
2121

22-
`python ./verifyio.py /path/to/traces /path/to/traces/conflicts.txt`
22+
3. Finally run the verification code, which checks if those potential conflicting operations are properly synchronzied.
23+
24+
```python
25+
python ./verifyio.py -h # print out usage
26+
27+
#Example:
28+
python ./verifyio.py /path/to/traces /path/to/traces/conflicts.txt --semantics=mpi
29+
```
2330

2431

2532

0 commit comments

Comments
 (0)