Skip to content

Commit a85006d

Browse files
committed
Updated comments based on feedback
Clarified entry points comments. Added formatting detection.
1 parent 214efbf commit a85006d

File tree

3 files changed

+9
-5
lines changed

3 files changed

+9
-5
lines changed

include/swift/Frontend/FrontendOptions.h

+5-1
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,11 @@ class FrontendOptions {
231231
/// Indicates whether the playground transformation should be applied.
232232
bool PlaygroundTransform = false;
233233

234-
/// Indicates whether the pc macro should be applied.
234+
/// Indicates whether the AST should be instrumented to simulate a debugger's
235+
/// program counter. Similar to the PlaygroundTransform, this will instrument
236+
/// the AST with function calls that get called when you would see a program
237+
/// counter move in a debugger. To adopt this implement the
238+
/// __builtin_pc_before and __builtin_pc_after functions.
235239
bool PCMacro = false;
236240

237241
/// Indicates whether the playground transformation should omit

include/swift/Subsystems.h

+3-3
Original file line numberDiff line numberDiff line change
@@ -153,9 +153,9 @@ namespace swift {
153153
/// instrumentation that has a high runtime performance impact.
154154
void performPlaygroundTransform(SourceFile &SF, bool HighPerformance);
155155

156-
/// Once parsing, name-binding and the playground transform (if required)
157-
/// are complete this optionally walks the ASTs to add calls to externally
158-
/// provided functions that simulate "program counter"-like debugging events.
156+
/// Once parsing and name-binding are complete this optionally walks the ASTs
157+
/// to add calls to externally provided functions that simulate
158+
/// "program counter"-like debugging events.
159159
void performPCMacro(SourceFile &SF, TopLevelContext &TLC);
160160

161161
/// Flags used to control type checking.

lib/Sema/InstrumenterSupport.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//===--- InstrumenterSupport.h - Instrumenter Support ---------------------===//
1+
//===--- InstrumenterSupport.h - Instrumenter Support -----------*- C++ -*-===//
22
//
33
// This source file is part of the Swift.org open source project
44
//

0 commit comments

Comments
 (0)