Merge pull request #79772 from gottesmm/pr-9dc8d133c4df0ac75898153321c06dfee9f3416a

[DebuggingTheCompiler] Add a note about using -debug-cycles to debug request evaluator cycles.

Author: gottesmm

docs/DebuggingTheCompiler.md

@@ -219,6 +219,26 @@ passing the flag `-Xfrontend -debug-constraints`:
     $ swift repl -Xfrontend -debug-constraints
     1> let foo = 1
 
+### Debugging Evaluator Cycles
+
+When triggering code in the type checker, one can by mistake cause a cycle in
+the request evaluator. The error looks as follows:
+
+```
+<unknown>:0: error: circular reference
+file.swift:18:22: note: through reference here
+16 | 
+17 | extension MyType {
+18 |   public static func test() -> MyType { ... }
+   |                      `- note: through reference here
+19 | }
+20 | 
+```
+
+To determine the actual circular request that is occuring, one can pass in the
+flag `-debug-cycles` to the compiler which will cause the compiler to dump out
+the linear chain of requests that led to the cycle.
+
 ## Debugging on SIL Level
 
 ### Options for Dumping the SIL