Skip to content

Commit 552db27

Browse files
authored
Update README with clearer scip usage instructions
1 parent 90274a7 commit 552db27

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,12 @@ This tool can be used to generate a graph of callers/callees for a given rust pr
55
If you want to use your own json file, you need to install:
66

77
- [rust-analyzer](https://rust-analyzer.github.io/book/installation.html) it is used to generate a scip output file: one needs to run `rust-analyzer scip .` from the command line within a rust project; this will generate `index.scip` within the rust project;
8-
- [scip](https://github.com/sourcegraph/scip) it is used to generate a JSON from the scip output file: one needs to run `scip print --json index.scip > index_scip.json` to obtain `index_scip.json` which is then given as input to obtian the call graphs.
8+
- [scip](https://github.com/sourcegraph/scip) it is used to generate a JSON from the scip output file.
99

1010
### Note
11-
You can use [these scripts](https://github.com/Beneficial-AI-Foundation/installers_for_various_tools) to install the tools and to [generate the json](https://github.com/Beneficial-AI-Foundation/installers_for_various_tools?tab=readme-ov-file#generate-scip-index).
11+
You can use [these scripts](https://github.com/Beneficial-AI-Foundation/installers_for_various_tools) to install the tools and to [generate the json](https://github.com/Beneficial-AI-Foundation/installers_for_various_tools?tab=readme-ov-file#generate-scip-index). If you prefer to use `rust-analyzer` and `scip` on your own, you need to run:
12+
- `rust-analyzer scip .` from the command line within a rust project; this will generate `index.scip` within the rust project;
13+
- `scip print --json index.scip > index_scip.json` to obtain `index_scip.json` which is then given as input to obtain the call graphs.
1214

1315
If you just want to get info about `libsignal`, simply replace `index_scip.json` by `index_scip_libsignal_deps.json` in the commands below. (If you want to format it so you can see its structure, you can use the command `jq '.' index_scip_libsignal_deps.json > formatted_index_scip_libsignal_deps
1416
.json`.)

0 commit comments

Comments
 (0)