Skip to content

Commit 4018056

Browse files
committed
[swift-inspect] update README.md for Linux CMake build
1 parent 5b4b86e commit 4018056

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

tools/swift-inspect/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,15 @@ In order to build on Windows with CMake, some additional parameters must be pass
3232
cmake -B out -G Ninja -S . -D ArgumentParser_DIR=... -D CMAKE_Swift_FLAGS="-Xcc -I%SDKROOT%\usr\include\swift\SwiftRemoteMirror"
3333
~~~
3434

35+
In order to build on Linux with CMake, some additional parameters must be passed to the build tool to locate the necessary Swift modules.
36+
37+
~~~
38+
cmake -B out -G Ninja -S . -D ArgumentParser_DIR=... -D CMAKE_Swift_FLAGS="-Xcc -I$(git rev-parse --show-toplevel)/include/swift/SwiftRemoteMirror"
39+
~~~
40+
41+
Building with CMake requires a local copy of [swift-argument-parser](https://github.com/apple/swift-argument-parser) built with CMake.
42+
The `ArumentParser_DIR=` definition must refer to the `cmake/modules` sub-directory of the swift-argument-parser build output directory.
43+
3544
### Using
3645

3746
The following inspection operations are available currently.

0 commit comments

Comments
 (0)