Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Put "cross-repo" optional step before SCIP index generation #742

Merged
merged 1 commit into from
Aug 21, 2024
Merged

docs: Put "cross-repo" optional step before SCIP index generation #742

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 16 additions & 14 deletions docs/manual-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,21 +140,8 @@ build/semanticdb-targetroot/META-INF/semanticdb/j8/src/main/java/example/Example
...
```

## Step 4: Generate SCIP index from SemanticDB files

First, install the `scip-java` command-line tool according to the instructions
in the [getting started guide](getting-started.md).

Next, run the `scip-java index-semanticdb` command to convert SemanticDB files
into SCIP.

```sh
❯ scip-java index-semanticdb $TARGETROOT
❯ file index.scip
index.scip: JSON data
```

## Step 5 (optional): Enable cross-repository navigation
## Step 4 (optional): Enable cross-repository navigation

Cross-repository navigation is a feature that allows "goto definition" and "find
references" to show results from multiple repositories.
Expand Down Expand Up @@ -228,3 +215,18 @@ Which allows you to invoke it by simply running `mvn sourcegraph:sourcegraphDepe

Cross-repository navigation is a feature that allows "goto definition" and "find
references" to show results from multiple repositories.

## Step 5: Generate SCIP index from SemanticDB files

First, install the `scip-java` command-line tool according to the instructions
in the [getting started guide](getting-started.md).

Next, run the `scip-java index-semanticdb` command to convert SemanticDB files
into SCIP.

```sh
❯ scip-java index-semanticdb $TARGETROOT
❯ file index.scip
index.scip: JSON data
```

Loading