Skip to content

Commit 3333bd4

Browse files
authored
Update build instructions to require Swift 5.7 (#107)
The repo's instructions were pointing to Swift 5.5, but today it makes use of [PathRemapper](https://github.com/apple/llvm-project/blob/swift/release/5.7/clang/include/clang/Basic/PathRemapper.h), which was introduced in 5.7. Closes #106 Signed-off-by: Bruno Rocha <[email protected]>
1 parent 2ca7011 commit 3333bd4

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ The build uses [CMake](https://cmake.org) because [Apple's LLVM fork](https://gi
7575

7676
When building Swift, keep the following in mind:
7777

78-
1. Checkout the desired release branch of Swift using something like `./swift/utils/update-checkout --clone --scheme release/5.5`.
78+
1. Checkout the desired release branch of Swift using something like `./swift/utils/update-checkout --clone --scheme release/5.7`.
7979
2. Build Swift using `--release`/`-R` for performance
8080

8181
Building all of Swift can take a long time, and most of that isn't needed by `index-import`. A faster way to build `index-import`, is to build only `libIndexStore.dylib`. Here are the commands to do just that:
@@ -107,7 +107,7 @@ open index-import.xcodeproj
107107

108108
## Index File Format
109109

110-
The index consists of two types of files, Unit files and Record files. Both are [LLVM Bitstream](https://www.llvm.org/docs/BitCodeFormat.html#bitstream-format), a common binary format used by LLVM/Clang/Swift. Record files contain no paths and can be simply copied. Only Unit files contain paths, so only unit files need to be rewritten. A read/write API is available in the `clangIndex` library. `index-import` uses [`IndexUnitReader`](https://github.com/apple/llvm-project/blob/swift/release/5.5/clang/include/clang/Index/IndexUnitReader.h) and [`IndexUnitWriter`](https://github.com/apple/llvm-project/blob/swift/release/5.5/clang/include/clang/Index/IndexUnitWriter.h).
110+
The index consists of two types of files, Unit files and Record files. Both are [LLVM Bitstream](https://www.llvm.org/docs/BitCodeFormat.html#bitstream-format), a common binary format used by LLVM/Clang/Swift. Record files contain no paths and can be simply copied. Only Unit files contain paths, so only unit files need to be rewritten. A read/write API is available in the `clangIndex` library. `index-import` uses [`IndexUnitReader`](https://github.com/apple/llvm-project/blob/swift/release/5.7/clang/include/clang/Index/IndexUnitReader.h) and [`IndexUnitWriter`](https://github.com/apple/llvm-project/blob/swift/release/5.7/clang/include/clang/Index/IndexUnitWriter.h).
111111

112112
## Resources
113113

0 commit comments

Comments
 (0)