From 35435b942332e7815d3815616389e376784ecc99 Mon Sep 17 00:00:00 2001 From: Anton Sviridov Date: Wed, 21 Aug 2024 08:52:21 +0100 Subject: [PATCH] docs: Put "cross-repo" optional step before SCIP index generation (#742) --- docs/manual-configuration.md | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/docs/manual-configuration.md b/docs/manual-configuration.md index 60744883..f1a5e3ce 100644 --- a/docs/manual-configuration.md +++ b/docs/manual-configuration.md @@ -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. @@ -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 +``` +