Skip to content

Commit 049af2e

Browse files
committed
[linux] add Linux build instructions to README.txt
1 parent 2ee5d15 commit 049af2e

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

tools/swift-inspect/README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,14 @@ In order to build on Windows, some additional parameters must be passed to the b
1616
swift build -Xcc -I%SDKROOT%\usr\include\swift\SwiftRemoteMirror -Xlinker %SDKROOT%\usr\lib\swift\windows\x86_64\swiftRemoteMirror.lib
1717
~~~
1818

19+
#### Linux
20+
21+
In order to build on Linux, some additional parameters must be passed to the build tool to loace the necessary includes and libraries
22+
23+
~~~
24+
swift build -Xswiftc -I$(git rev-parse --show-toplevel)/include/swift/SwiftRemoteMirror -Xswiftc -lswiftRemoteMirror
25+
~~~
26+
1927
#### CMake
2028

2129
In order to build on Windows with CMake, some additional parameters must be passed to the build tool to locate the necessary Swift modules.
@@ -30,9 +38,6 @@ The following inspection operations are available currently.
3038

3139
##### All Platforms
3240

33-
dump-arrays <name-or-pid>
34-
: Print information about array objects in the target
35-
3641
dump-cache-nodes <name-or-pid>
3742
: Print the metadata cache nodes.
3843

@@ -45,6 +50,11 @@ dump-generic-metadata <name-or-pid> [--backtrace] [--backtrace-long]
4550
dump-raw-metadata <name-or-pid> [--backtrace] [--backtrace-long]
4651
: Print metadata allocations.
4752

53+
#### Darwin and Windows Only
54+
55+
dump-arrays <name-or-pid>
56+
: Print information about array objects in the target
57+
4858
##### Darwin Only
4959

5060
dump-concurrency <name-or-pid>

0 commit comments

Comments
 (0)