Skip to content

Commit 900a2a6

Browse files
committed
docs: remove per-file SCIP shards section
1 parent 6ae2659 commit 900a2a6

1 file changed

Lines changed: 0 additions & 16 deletions

File tree

docs/design.md

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -23,19 +23,3 @@ There are several benefits to implementing scip-java as a compiler plugin:
2323
tool, we minimize the risk of diverging from the CI build environment such as
2424
installed system dependencies, custom compiler options and custom annotation
2525
processors.
26-
27-
### Why per-file SCIP shards?
28-
29-
The compiler plugin writes a small SCIP shard per compilation unit and a
30-
separate step aggregates the shards into a single SCIP index. There are several
31-
benefits to this two-phase pipeline:
32-
33-
- **Simplicity**: It's easy to translate a single Java source file into a single
34-
SCIP shard inside a compiler plugin. It would be more complicated to produce
35-
a full SCIP index from inside the plugin because compiler plugins don't have
36-
access to a project-wide context, which is necessary to produce accurate
37-
definitions and hovers in multi-module projects with external library
38-
dependencies.
39-
- **Performance**: Each compilation unit can be processed independently to keep
40-
memory usage low. The final aggregation of the shards into a single SCIP
41-
index can be safely parallelized.

0 commit comments

Comments
 (0)