Skip to content

Commit c76feaa

Browse files
docs: Add notes on debugging + consuming SCIP. (#69)
1 parent 262268e commit c76feaa

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

Development.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,11 @@
3434
cd cmd/tests/reprolang
3535
./generate-tree-sitter-parser.sh
3636
```
37+
38+
## Debugging
39+
40+
Protobuf output can be inspected using `protoc`:
41+
42+
```
43+
protoc --decode=scip.Index -I /path/to/scip scip.proto < index.scip
44+
```

Readme.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,15 @@ check out the [announcement blog post](https://about.sourcegraph.com/blog/announ
2020
If you're interested in writing a new indexer that emits SCIP,
2121
check out our documentation on
2222
[how to write an indexer](https://docs.sourcegraph.com/code_intelligence/explanations/writing_an_indexer).
23+
Also, check out the [Debugging section][] in the Development docs.
24+
25+
If you're interested in consuming SCIP data,
26+
you can either use one of the [provided language bindings](https://github.com/sourcegraph/scip/tree/main/bindings),
27+
or generate code for the [SCIP protobuf schema](./scip.proto)
28+
using the protobuf toolchain for your language ecosystem.
29+
Also, check out the [Debugging section][] in the Development docs.
30+
31+
[debugging section]: ./Development.md#debugging
2332

2433
## Contributing
2534

0 commit comments

Comments
 (0)