Skip to content

Commit da4bea8

Browse files
[Docs] Add note about debugging with --release-debuginfo build-script flag (#62048)
1 parent 3a93925 commit da4bea8

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/HowToGuides/GettingStarted.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -256,6 +256,12 @@ Phew, that's a lot to digest! Now let's proceed to the actual build itself!
256256
containing the Swift compiler and standard library and clang/LLVM build artifacts.
257257
If the build fails, see [Troubleshooting build issues](#troubleshooting-build-issues).
258258
259+
> **Note:**
260+
> `--release-debuginfo` means that although debug information will be produced, all targets will
261+
> be compiled in release mode, meaning optimized code, which can affect your debugging experience.
262+
> Consider [`--debug-swift` to build a debug variant of the compiler](#debugging-issues) and have
263+
> the swift targets (including `swift-frontend`) built in debug mode.
264+
259265
If you would like to additionally build the Swift corelibs,
260266
ie swift-corelibs-libdispatch, swift-corelibs-foundation, and swift-corelibs-xctest,
261267
on Linux, add the `--xctest` flag to `build-script`.

0 commit comments

Comments
 (0)