Skip to content

Commit 241f8ad

Browse files
committed
Add a section to the Enable Experimental Background Indexing document to describe the behavior without background indexing
1 parent 5c2055d commit 241f8ad

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

Documentation/Enable Experimental Background Indexing.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
1-
# Background Indexing
1+
# Enable Experimental Background Indexing
22

33
Background indexing in SourceKit-LSP is available as an experimental feature. This guide shows how to set up background indexing and which caveats to expect.
44

5+
## Behavior Without Background Indexing
6+
7+
By default SourceKit-LSP does not update its global index in the background or build Swift modules in the background. Thus, a lot of cross-module or global functionality is limited if the project hasn't been built recently. For example consider two modules: `Lib` and `Exec`, where `Exec` depends on `Lib`: Without background indexing, if a function is added to `Lib`, completion/jump to definition/etc in `Exec` would not be able to see that function until after a build. Background indexing solves that issue.
8+
59
## Set Up
610

711
1. Install a `main` or `release/6.0` Swift Development Snapshot from https://www.swift.org/install or install the [Xcode 16 beta](https://developer.apple.com/xcode/).

0 commit comments

Comments
 (0)