-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(docs): CallGraph Documentation (#28)
Closes #24 --------- Co-authored-by: Georgiy Komarov <jubnzv@gmail.com>
- Loading branch information
Showing
4 changed files
with
335 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# DumpCallGraph | ||
|
||
Misti provides a feature to dump the [Call Graph (CG)](https://en.wikipedia.org/wiki/Call_graph) in JSON, DOT, and Mermaid formats. This is essential for understanding the function call relationships within your Tact contracts and analyzing the flow of function calls. | ||
|
||
## Usage | ||
|
||
To dump the CG in Mermaid format, use the following command: | ||
|
||
```bash | ||
misti -t "DumpCallGraph:format=mmd" <TACT_CONFIG_PATH|TACT_FILE_PATH> > callgraph.mmd | ||
``` | ||
|
||
To dump the CG in Graphviz DOT format, use the following command: | ||
|
||
```bash | ||
misti -t "DumpCallGraph:format=dot" <TACT_CONFIG_PATH|TACT_FILE_PATH> > callgraph.dot | ||
``` | ||
|
||
To dump the CG in JSON format, use the following command: | ||
|
||
```bash | ||
misti -t "DumpCallGraph:format=json" <TACT_CONFIG_PATH|TACT_FILE_PATH> > callgraph.json | ||
``` | ||
|
||
## Further Information | ||
|
||
For detailed instructions on how to work with the generated Mermaid, Graphviz DOT, and JSON files—including how to view, convert, and visualize them—please refer to the [DumpCfg documentation](./DumpCfg.md#working-with-graphviz). The steps and tools used for `DumpCallGraph` outputs are the same as those described for `DumpCfg`. | ||
|
||
By utilizing the `DumpCallGraph` tool, developers can gain deeper insights into the function call structure of their contracts and effectively debug and enhance their code. | ||
|
||
--- | ||
|
||
**Note:** Replace `<TACT_CONFIG_PATH|TACT_FILE_PATH>` with the actual path to your Tact configuration file or Tact contract file when running the commands. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.