Merge pull request #518 from microsoft/main

1.70

_implementors/adapters.md

@@ -56,6 +56,7 @@ Many adapters publish releases tailored for specific editors, such as VS Code, a
 [LLDB Debugger](https://github.com/vadimcn/vscode-lldb)|[@vadimcn](https://github.com/vadimcn)|[VS Code](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb)
 [Lua and Ravi 5.3 Debugger](https://github.com/dibyendumajumdar/ravi-vscode-debugger)|[@dibyendumajumdar](https://github.com/dibyendumajumdar)|[VS Code](https://marketplace.visualstudio.com/items?itemName=ravilang.ravi-debug)
 [Lua Debug](https://github.com/actboy168/lua-debug)|[@actboy168](https://github.com/actboy168)|[VS Code](https://marketplace.visualstudio.com/items?itemName=actboy168.lua-debug)
+[Luau Debugger](https://github.com/sssooonnnggg/luau-debugger)|[@sssooonnnggg](https://github.com/sssooonnnggg)|[VS Code](https://marketplace.visualstudio.com/items?itemName=sssooonnnggg.luau-debugger)
 [Mock Debug](https://github.com/Microsoft/vscode-mock-debug)|[@roblourens](https://github.com/roblourens)|[VS Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode.mock-debug)
 [Mono Debug](https://github.com/Microsoft/vscode-mono-debug)|[@akoeplinger](https://github.com/akoeplinger)|[VS Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode.mono-debug)
 [NAME](https://github.com/utdscheld/name)|[John Cole](https://personal.utdallas.edu/~John.Cole/)|

changelog.md

@@ -6,6 +6,10 @@ sectionid: changelog
 
 #### All notable changes to the specification will be documented in this file.
 
+* 1.70.x
+  * Clarify how `StackTraceArguments.format` applies
+  * Clarify the default behavior of `ContinuedEvent.allThreadsContinued`
+
 * 1.69.x
   * Clarify the flow diagram to start a debug session
   * Add `supportsANSIStyling` capabilities to allow colorization of text from debug adapters

debugAdapterProtocol.json

@@ -249,7 +249,7 @@
 							},
 							"allThreadsContinued": {
 								"type": "boolean",
-								"description": "If `allThreadsContinued` is true, a debug adapter can announce that all threads have continued."
+								"description": "If omitted or set to `true`, this event signals to the client that all threads have been resumed. The value `false` indicates that not all threads were resumed."
 							}
 						},
 						"required": [ "threadId" ]
@@ -1673,7 +1673,7 @@
 						"properties": {
 							"allThreadsContinued": {
 								"type": "boolean",
-								"description": "The value true (or a missing property) signals to the client that all threads have been resumed. The value false indicates that not all threads were resumed."
+								"description": "If omitted or set to `true`, this response signals to the client that all threads have been resumed. The value `false` indicates that not all threads were resumed."
 							}
 						}
 					}
@@ -2033,7 +2033,7 @@
 				},
 				"format": {
 					"$ref": "#/definitions/StackFrameFormat",
-					"description": "Specifies details on how to format the stack frames.\nThe attribute is only honored by a debug adapter if the corresponding capability `supportsValueFormattingOptions` is true."
+					"description": "Specifies details on how to format the returned `StackFrame.name`. The debug adapter may format requested details in any way that would make sense to a developer.\nThe attribute is only honored by a debug adapter if the corresponding capability `supportsValueFormattingOptions` is true."
 				}
 			},
 			"required": [ "threadId" ]

index.html

@@ -86,7 +86,7 @@ <h1 class="text-center"><i class="fa fa-cogs" aria-hidden="true"></i></h1>
             <h1 class="text-center"><i class="fas fa-book" aria-hidden="true"></i></h1>
             <a href='{{ "/specification" | prepend: site.baseurl }}'><h3 class="text-center">Specification</h3></a>
             <p>
-                The latest version of the protocol specification is version 1.64.0.
+                The latest version of the protocol specification is version 1.70.0.
             </p>
             <p>
                 <a href='{{ "/changelog" | prepend: site.baseurl }}'>Change History</a>

overview.md

@@ -179,7 +179,7 @@ After the response to `configurationDone` is sent, the debug adapter may respond
 
 The following sequence diagram summarizes the sequence of requests and events for a hypothetical _gdb_ debug adapter:
 
-<img src="./img/init-launch.svg" width="100%">
+<img src="./img/init-launch.svg" width="100%" alt="Sequence diagram of the launch flow">
 
 ### Stopping and accessing debuggee state
 
@@ -233,7 +233,7 @@ If the debuggee has ended (and the debug adapter is able to detect this), an opt
 
 This diagram summarizes the sequence of request and events for a hypothetical debug adapter for _gdb_:
 
-<img src="./img/stop-continue-terminate.svg" width="100%" />
+<img src="./img/stop-continue-terminate.svg" width="100%" alt="Sequence diagram of the termination flow" />
 
 ## Libraries (SDKs) for DAP providers and consumers
 

specification.md

@@ -313,8 +313,9 @@ interface ContinuedEvent extends Event {
     threadId: number;
 
     /**
-     * If `allThreadsContinued` is true, a debug adapter can announce that all
-     * threads have continued.
+     * If omitted or set to `true`, this event signals to the client that all
+     * threads have been resumed. The value `false` indicates that not all
+     * threads were resumed.
      */
     allThreadsContinued?: boolean;
   };
@@ -1811,9 +1812,9 @@ Response to `continue` request.
 interface ContinueResponse extends Response {
   body: {
     /**
-     * The value true (or a missing property) signals to the client that all
-     * threads have been resumed. The value false indicates that not all threads
-     * were resumed.
+     * If omitted or set to `true`, this response signals to the client that all
+     * threads have been resumed. The value `false` indicates that not all
+     * threads were resumed.
      */
     allThreadsContinued?: boolean;
   };
@@ -2222,7 +2223,9 @@ interface StackTraceArguments {
   levels?: number;
 
   /**
-   * Specifies details on how to format the stack frames.
+   * Specifies details on how to format the returned `StackFrame.name`. The
+   * debug adapter may format requested details in any way that would make sense
+   * to a developer.
    * The attribute is only honored by a debug adapter if the corresponding
    * capability `supportsValueFormattingOptions` is true.
    */