Skip to content

Commit 349e9ee

Browse files
committed
Update settings.md accordingly
1 parent 5bf5cf0 commit 349e9ee

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

docs/settings.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,16 +46,22 @@ This controls the display of Inlay Hints. Inlay Hints are variable annotations i
4646

4747
Trace the communication between Visual Studio Code and the SourceKit-LSP server. The output from this is sent to an Output Window called "Sourcekit Language Server"
4848

49+
### Cross Compilation (Experimental)
50+
51+
Cross-compilation is the act of compiling code for one computer system on a different system. The Swift compiler, which is based on LLVM, is a native cross-compiler and SwiftPM is capable of building a package for custom "destination".
52+
53+
> **NOTE:** Cross-compilation settings are not suggested to be set globally, as different projects often target different destinations.
54+
55+
- **Destination > SDK**
56+
57+
The path of the SDK to compile against. The default destination SDK is determined by the environment on macOS and Windows. This adds the `--sdk` command line parameter to the relevant SwiftPM calls.
58+
4959
### Advanced
5060

5161
- **Runtime Path**
5262

5363
Where to find Swift runtime libraries. This is mainly of use when these libraries cannot be discovered via the RPATH. On Windows the runtime path is added to the `Path` environment variable. This is of less use on macOS and Linux but will be added to `DYLD_LIBRARY_PATH` and `LD_LIBRARY_PATH` environment variables respectively on each platform. This is of use when supporting non-standard SDK layouts on Windows
5464

55-
- **SDK**
56-
57-
The path of the target SDK to compile against. The default SDK is determined by the environment on macOS and Windows. This is of use when supporting non-standard SDK layouts on Windows and using custom SDKs. This adds the `--sdk` command line parameter to the relevant `swift` calls.
58-
5965
- **Diagnostics**
6066

6167
The Swift extension includes a Swift Output channel that events are logged in. You can access this by selecting menu item `View -> Output` and then selecting `Swift` in the drop down menu. Events like adding new folders, LSP server starting, errors and package resolves/updates are recorded in here. This is all useful information when trying to debug an issue with the extension. Enabling the diagnostics setting will extend this information to include considerably more information. If you want to report a bug with the extension it would be good practice to enable this setting, restart Visual Studio Code and once you have replicated your bug include the contents of the Swift Output channel in the bug report.

0 commit comments

Comments
 (0)