Skip to content

Commit 97c7af4

Browse files
committed
docs: Add documentation of -vast-snapshot-at CLI option.
1 parent 329a28f commit 97c7af4

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

docs/GettingStarted/debug.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,7 @@ vast-opt --pass-pipeline="pipeline-string"
3232

3333
### Debug Pipeline
3434

35-
With the `-vast-debug` option, you get more detailed crash reports. It shows MLIR operations when there's an error and provides current stack traces.
35+
With the `-vast-debug` option, you get more detailed crash reports. It shows MLIR operations when there's an error and provides current stack traces.
36+
37+
Sometimes it is needed to examine the results of conversion steps more closely to discover what went wrong. `-vast-snapshot-at=pass1;...;passN` will instrument conversion pipeline to store a result of `passN` into a file after it is applied. Name of the file will be in the form of: `basename.pass_name`.
38+
Passing `"*"` in the string will result in output after every step.

docs/Tools/vast-front.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,10 @@ Additional customization options include:
4444
- `-vast-disable-vast-verifier`
4545
- Skips verification of the produced VAST MLIR module.
4646

47+
- `vast-snapshot-at="pass1;...;passN`
48+
- After each pass that was specified as an option store MLIR into a file (format is `src.pass_name`).
49+
- `"*"` stores snapshot after every conversion.
50+
4751
## Pipelines
4852

49-
WIP pipelines documentation
53+
WIP pipelines documentation

0 commit comments

Comments
 (0)