Skip to content

Commit 01b09ec

Browse files
committed
Address review feedback.
1 parent 0b8f679 commit 01b09ec

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ that generates one
1515
every `*.java` source file. After compilation completes, the SemanticDB files
1616
are processed to produce LSIF.
1717

18-
![A three stage pipeline that starts with a list of Java sources, creates a list of SemanticDB files that then become a single LSIF index.](docs/img/semanticdb-javac-pipeline.svg)
18+
![A three stage pipeline that starts with a list of Java sources, creates a list of SemanticDB files that then become a single LSIF index.](docs/assets/semanticdb-javac-pipeline.svg)
1919

2020
### Why Java compiler plugin?
2121

File renamed without changes.

docs/manual-configuration.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Indexing a codebase consists of two independent steps:
1515
- Compile the codebase with the SemanticDB compiler plugin.
1616
- Generate LSIF index from SemanticDB files.
1717

18-
![A three stage pipeline that starts with a list of Java sources, creates a list of SemanticDB files that then become a single LSIF index.](docs/img/semanticdb-javac-pipeline.svg)
18+
![A three stage pipeline that starts with a list of Java sources, creates a list of SemanticDB files that then become a single LSIF index.](assets/semanticdb-javac-pipeline.svg)
1919

2020
## Step 1: Add SemanticDB compiler plugin to the classpath
2121

@@ -46,7 +46,7 @@ If you're using sbt.
4646
libraryDependencies += "com.sourcegraph" % "semanticdb-javac" % "@STABLE_VERSION@"
4747
```
4848

49-
## Step 2: enable `-Xplugin:semanticdb` compiler option
49+
## Step 2: Enable `-Xplugin:semanticdb` compiler option
5050

5151
Add `-Xplugin:semanticdb` to your compiler options to enable the SemanticDB
5252
compiler plugin. To do this you need to explicitly configure two directories:
@@ -102,13 +102,13 @@ Compile / javacOptions += {
102102
}
103103
```
104104

105-
## Step 4: compile the codebase
105+
## Step 3: Compile the codebase
106106

107107
Compile all source files in the codebase once the compiler setting has been
108108
configured. The exact command depends on your build tool. Below are some
109109
examples:
110110

111-
- Gradle: `./gradlew clean compileTestJava`
111+
- Gradle: `./gradlew clean compileJava compileTestJava`
112112
- Maven: `mvn clean verify -DskipTests`
113113
- sbt: `sbt clean test:compile`
114114
- Bazel: `bazel build //...`
@@ -123,7 +123,7 @@ build/semanticdb-targetroot/META-INF/semanticdb/j8/src/main/java/example/Example
123123
...
124124
```
125125

126-
## Step 5: generate LSIF index from SemanticDB files
126+
## Step 4: Generate LSIF index from SemanticDB files
127127

128128
Run the `lsif-java index-semanticdb` command to convert SemanticDB files into
129129
LSIF.

0 commit comments

Comments
 (0)