clarify instruction bp offset, add instruction presentationHint (#436)

Fixes #341
microsoft · Oct 5, 2023 · 1b290c8 · 1b290c8
1 parent 36fbbbb
commit 1b290c8
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/changelog.md b/changelog.md
@@ -6,6 +6,10 @@ sectionid: changelog
 
 #### All notable changes to the specification will be documented in this file.
 
+* 1.65.x
+  * Clarify that the `offset` in the `InstructionBreakpoint` is given in bytes
+  * Add a `presentationHint` to the `DisassembledInstruction`
+
 * 1.63.x
   * Add `memoryReference` support to the `SetVariableResponse`/`SetExpressionResponse`
   * Fix a typo in the description of `BreakpointLocationsArguments`

diff --git a/debugAdapterProtocol.json b/debugAdapterProtocol.json
@@ -3765,7 +3765,7 @@
 				},
 				"offset": {
 					"type": "integer",
-					"description": "The offset from the instruction reference.\nThis can be negative."
+					"description": "The offset from the instruction reference in bytes.\nThis can be negative."
 				},
 				"condition": {
 					"type": "string",
@@ -4159,7 +4159,12 @@
 				"endColumn": {
 					"type": "integer",
 					"description": "The end column of the range that corresponds to this instruction, if any."
-				}
+				},
+				"presentationHint": {
+					"type": "string",
+					"description": "A hint for how to present the instruction in the UI.\n\nA value of `invalid` may be used to indicate this instruction is 'filler' and cannot be reached by the program. For example, unreadable memory addresses may be presented is 'invalid.'",
+					"enum": [ "normal", "invalid" ]
+				},
 			},
 			"required": [ "address", "instruction" ]
 		},