Skip to content

Commit

Permalink
docs: Put "cross-repo" optional step before SCIP index generation (#742)
Browse files Browse the repository at this point in the history
  • Loading branch information
antonsviridov-src authored Aug 21, 2024
1 parent d314dd8 commit 35435b9
Showing 1 changed file with 16 additions and 14 deletions.
30 changes: 16 additions & 14 deletions docs/manual-configuration.md
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
```

0 comments on commit 35435b9

Please sign in to comment.