Skip to content

Commit 2abd100

Browse files
committed
Fix mangled SCIP/SemanticDB doc references
1 parent 9330f4c commit 2abd100

5 files changed

Lines changed: 22 additions & 20 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Java and Kotlin indexer for [SCIP](https://github.com/sourcegraph/scip) ![](https://img.shields.io/badge/status-development-green?style=flat)
1+
# Java and Kotlin indexer for [SCIP](https://github.com/scip-code/scip) ![](https://img.shields.io/badge/status-development-green?style=flat)
22

33
| Documentation | Link |
44
| -------------------- | ---------------------------------------------------------------------- |

docs/design.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ title: Design
55

66
This project is implemented as a
77
[Java compiler plugin](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.compiler/com/sun/source/util/Plugin.html)
8-
that generates one
9-
[SCIP](https://scalameta.org/docs/scip/specification.html) file for
10-
every `*.java` source file. After compilation completes, the SCIP files
11-
are processed to produce SCIP.
8+
that generates one partial
9+
[SCIP](https://github.com/scip-code/scip) index (a "shard") for
10+
every `*.java` source file. After compilation completes, the per-file SCIP
11+
shards are merged into a single SCIP index.
1212

1313
### Why Java compiler plugin?
1414

@@ -25,20 +25,21 @@ There are several benefits to implementing scip-java as a compiler plugin:
2525
installed system dependencies, custom compiler options and custom annotation
2626
processors.
2727

28-
### Why SCIP?
28+
### Why per-file SCIP shards?
2929

30-
SCIP is Protobuf schema for information about symbols and types in Java
31-
programs and other languages. There are several benefits to using SCIP as
32-
an intermediary representation for SCIP:
30+
[SCIP](https://github.com/scip-code/scip) is a Protobuf schema for information
31+
about symbols and types in Java programs and other languages. There are several
32+
benefits to emitting one SCIP shard per source file and merging them afterwards:
3333

3434
- **Simplicity**: It's easy to translate a single Java source file into a single
35-
SCIP file inside a compiler plugin. It's more complicated to produce
36-
SCIP because compiler plugins does not have access to a project-wide context,
37-
which is necessary to produce accurate definitions and hovers in multi-module
38-
projects with external library dependencies.
39-
- **Performance**: SCIP is fast to write and read. Each compilation unit
40-
can be processed independently to keep memory usage low. The final conversion
41-
from SCIP to SCIP can be safely parallelized.
35+
SCIP shard inside a compiler plugin. It's more complicated to produce a
36+
complete project-wide index directly because compiler plugins do not have
37+
access to a project-wide context, which is necessary to produce accurate
38+
definitions and hovers in multi-module projects with external library
39+
dependencies.
40+
- **Performance**: SCIP shards are fast to write and read. Each compilation unit
41+
can be processed independently to keep memory usage low. The final merge of
42+
the shards into a single index can be safely parallelized.
4243
- **Cross-repository**: Compiler plugins have access to both source code and the
4344
classpath (compiled bytecode of upstream dependencies). SCIP has been
4445
designed so that it's also possible to generate spec-compliant symbols from

docs/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Getting started
44
---
55

66
By following the instructions on this page, you should be able to generate a
7-
[SCIP](https://github.com/sourcegraph/scip) index of your Java codebase using
7+
[SCIP](https://github.com/scip-code/scip) index of your Java codebase using
88
Gradle, Maven, or Bazel. See
99
[Supported build tools](#supported-build-tools) for an overview of other build
1010
tools that we're planning to support in the future.

scip-java/src/main/resources/scip-java/scip_java.bzl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ different contents.
99
This aspect is needed for scip-java to inspect the structure of the Bazel build
1010
and register actions to index all java_library/java_test/java_binary targets.
1111
The result of running this aspect is that your bazel-bin/ directory will contain
12-
many *.scip (https://github.com/sourcegraph/scip) files.
12+
many *.scip (https://github.com/scip-code/scip) files.
1313
These files encode information about which symbols are referenced from which
1414
locations in your source code.
1515

scip-javac/src/main/java/com/sourcegraph/scip_javac/GlobalSymbolsCache.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ private ScipSymbols.Descriptor scipDescriptor(Element sym) {
117117
}
118118

119119
/**
120-
* Computes the method "disambiguator" according to the SCIP spec.
120+
* Computes the method "disambiguator" according to the SemanticDB spec.
121121
*
122122
* <p><quote> Concatenation of a left parenthesis ("("), a tag and a right parenthesis (")"). If
123123
* the definition is not overloaded, the tag is empty. If the definition is overloaded, the tag is
@@ -131,7 +131,8 @@ private ScipSymbols.Descriptor scipDescriptor(Element sym) {
131131
*
132132
* </quote>
133133
*
134-
* <p><a href="https://scalameta.org/docs/scip/specification.html#symbol-2">Link to SCIP spec</a>.
134+
* <p><a href="https://scalameta.org/docs/semanticdb/specification.html#symbol-2">Link to
135+
* SemanticDB spec</a>.
135136
*/
136137
private String methodDisambiguator(ExecutableElement sym) {
137138
Iterable<? extends Element> elements = sym.getEnclosingElement().getEnclosedElements();

0 commit comments

Comments
 (0)