Skip to content

Commit cd8dbf8

Browse files
authored
Fix stopAtEntry, sourceFileMap, processId. (#13654)
1 parent 8452054 commit cd8dbf8

File tree

3 files changed

+36
-29
lines changed

3 files changed

+36
-29
lines changed

Extension/package.json

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3839,7 +3839,7 @@
38393839
},
38403840
"stopAtEntry": {
38413841
"type": "boolean",
3842-
"description": "%c_cpp.debuggers.stopAtEntry.description%",
3842+
"markdownDescription": "%c_cpp.debuggers.stopAtEntry.markdownDescription%",
38433843
"default": false
38443844
},
38453845
"debugServerPath": {
@@ -3888,16 +3888,15 @@
38883888
"default": false
38893889
},
38903890
"sourceFileMap": {
3891+
"markdownDescription": "%c_cpp.debuggers.sourceFileMap.markdownDescription%",
38913892
"anyOf": [
38923893
{
38933894
"type": "object",
3894-
"description": "%c_cpp.debuggers.sourceFileMap.description%",
38953895
"default": {
38963896
"<source-path>": "<target-path>"
38973897
}
38983898
},
38993899
{
3900-
"description": "%c_cpp.debuggers.sourceFileMap.sourceFileMapEntry.description%",
39013900
"type": "object",
39023901
"default": {
39033902
"<source-path>": {
@@ -4652,15 +4651,14 @@
46524651
"default": false
46534652
},
46544653
"processId": {
4654+
"markdownDescription": "%c_cpp.debuggers.processId.anyOf.markdownDescription%",
46554655
"anyOf": [
46564656
{
46574657
"type": "string",
4658-
"description": "%c_cpp.debuggers.processId.anyOf.description%",
46594658
"default": "${command:pickProcess}"
46604659
},
46614660
{
46624661
"type": "integer",
4663-
"description": "%c_cpp.debuggers.processId.anyOf.description%",
46644662
"default": 0
46654663
}
46664664
]
@@ -4676,16 +4674,15 @@
46764674
"default": false
46774675
},
46784676
"sourceFileMap": {
4677+
"markdownDescription": "%c_cpp.debuggers.sourceFileMap.markdownDescription%",
46794678
"anyOf": [
46804679
{
46814680
"type": "object",
4682-
"description": "%c_cpp.debuggers.sourceFileMap.description%",
46834681
"default": {
46844682
"<source-path>": "<target-path>"
46854683
}
46864684
},
46874685
{
4688-
"description": "%c_cpp.debuggers.sourceFileMap.sourceFileMapEntry.description%",
46894686
"type": "object",
46904687
"default": {
46914688
"<source-path>": {
@@ -5450,7 +5447,7 @@
54505447
},
54515448
"stopAtEntry": {
54525449
"type": "boolean",
5453-
"description": "%c_cpp.debuggers.stopAtEntry.description%",
5450+
"markdownDescription": "%c_cpp.debuggers.stopAtEntry.markdownDescription%",
54545451
"default": false
54555452
},
54565453
"dumpPath": {
@@ -5487,7 +5484,7 @@
54875484
},
54885485
"sourceFileMap": {
54895486
"type": "object",
5490-
"description": "%c_cpp.debuggers.sourceFileMap.description%",
5487+
"markdownDescription": "%c_cpp.debuggers.sourceFileMap.markdownDescription%",
54915488
"default": {
54925489
"<source-path>": "<target-path>"
54935490
}
@@ -5631,15 +5628,14 @@
56315628
"default": ""
56325629
},
56335630
"processId": {
5631+
"markdownDescription": "%c_cpp.debuggers.processId.anyOf.markdownDescription%",
56345632
"anyOf": [
56355633
{
56365634
"type": "string",
5637-
"description": "%c_cpp.debuggers.processId.anyOf.description%",
56385635
"default": "${command:pickProcess}"
56395636
},
56405637
{
56415638
"type": "integer",
5642-
"description": "%c_cpp.debuggers.processId.anyOf.description%",
56435639
"default": 0
56445640
}
56455641
]
@@ -5651,7 +5647,7 @@
56515647
},
56525648
"sourceFileMap": {
56535649
"type": "object",
5654-
"description": "%c_cpp.debuggers.sourceFileMap.description%",
5650+
"markdownDescription": "%c_cpp.debuggers.sourceFileMap.markdownDescription%",
56555651
"default": {
56565652
"<source-path>": "<target-path>"
56575653
}

Extension/package.nls.json

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -889,7 +889,12 @@
889889
"c_cpp.debuggers.miDebuggerArgs.description": "Additional arguments for the MI debugger (such as gdb).",
890890
"c_cpp.debuggers.miDebuggerServerAddress.description": "Network address of the MI Debugger Server to connect to (example: localhost:1234).",
891891
"c_cpp.debuggers.useExtendedRemote.description": "Connect to the MI Debugger Server with target extended-remote mode.",
892-
"c_cpp.debuggers.stopAtEntry.description": "Optional parameter. If true, the debugger should stop at the entrypoint of the target. If processId is passed, has no effect.",
892+
"c_cpp.debuggers.stopAtEntry.markdownDescription": {
893+
"message": "Optional parameter. If `true`, the debugger should stop at the entry point of the target. If `processId` is passed, this has no effect.",
894+
"comment": [
895+
"{Locked=\"`true`\"} {Locked=\"`processId`\"}"
896+
]
897+
},
893898
"c_cpp.debuggers.debugServerPath.description": "Optional full path to the debug server to launch. Defaults to null. It is used in conjunction with either \"miDebugServerAddress\" or your own server with a \"customSetupCommand\" that runs \"-target-select remote <server:port>\".",
894899
"c_cpp.debuggers.debugServerArgs.description": "Optional debug server args. Defaults to null.",
895900
"c_cpp.debuggers.serverStarted.description": "Optional server-started pattern to look for in the debug server output. Defaults to null.",
@@ -905,8 +910,18 @@
905910
"c_cpp.debuggers.cppvsdbg.console.externalTerminal.description": "Console applications will be launched in an external terminal window. The window will be reused in relaunch scenarios and will not automatically disappear when the application exits.",
906911
"c_cpp.debuggers.cppvsdbg.console.newExternalWindow.description": "Console applications will be launched in their own external console window which will end when the application stops. Non-console applications will run without a terminal, and stdout/stderr will be ignored.",
907912
"c_cpp.debuggers.avoidWindowsConsoleRedirection.description": "If true, disables debuggee console redirection that is required for Integrated Terminal support.",
908-
"c_cpp.debuggers.sourceFileMap.description": "Optional source file mappings passed to the debug engine. Example: '{ \"/original/source/path\":\"/current/source/path\" }'.",
909-
"c_cpp.debuggers.processId.anyOf.description": "Optional process id to attach the debugger to. Use \"${command:pickProcess}\" to get a list of local running processes to attach to. Note that some platforms require administrator privileges in order to attach to a process.",
913+
"c_cpp.debuggers.sourceFileMap.markdownDescription": {
914+
"message": "Optional source file mappings passed to the debug engine. Example: `{ \"<original source path>\": \"<current source path>\" }`.",
915+
"comment": [
916+
"{Locked=\"`{ \\\"<\"} {Locked=\">\\\": \\\"<\"} {Locked=\">\\\" }`\"}"
917+
]
918+
},
919+
"c_cpp.debuggers.processId.anyOf.markdownDescription": {
920+
"message": "Optional process ID to attach the debugger to. Use `${command:pickProcess}` to get a list of local running processes to attach to. Note that some platforms require administrator privileges in order to attach to a process.",
921+
"comment": [
922+
"{Locked=\"`${command:pickProcess}`\"}"
923+
]
924+
},
910925
"c_cpp.debuggers.symbolSearchPath.description": "Semicolon separated list of directories to use to search for symbol (that is, pdb) files. Example: \"c:\\dir1;c:\\dir2\".",
911926
"c_cpp.debuggers.dumpPath.description": "Optional full path to a dump file for the specified program. Example: \"c:\\temp\\app.dmp\". Defaults to null.",
912927
"c_cpp.debuggers.enableDebugHeap.description": "If false, the process will be launched with debug heap disabled. This sets the environment variable '_NO_DEBUG_HEAP' to '1'.",

Extension/tools/OptionsSchema.json

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -728,7 +728,7 @@
728728
},
729729
"stopAtEntry": {
730730
"type": "boolean",
731-
"description": "%c_cpp.debuggers.stopAtEntry.description%",
731+
"markdownDescription": "%c_cpp.debuggers.stopAtEntry.markdownDescription%",
732732
"default": false
733733
},
734734
"debugServerPath": {
@@ -777,17 +777,16 @@
777777
"default": false
778778
},
779779
"sourceFileMap": {
780+
"markdownDescription": "%c_cpp.debuggers.sourceFileMap.markdownDescription%",
780781
"anyOf": [
781782
{
782783
"type": "object",
783-
"description": "%c_cpp.debuggers.sourceFileMap.description%",
784784
"default": {
785785
"<source-path>": "<target-path>"
786786
}
787787
},
788788
{
789-
"$ref": "#/definitions/SourceFileMapEntry",
790-
"description": "%c_cpp.debuggers.sourceFileMap.sourceFileMapEntry.description%"
789+
"$ref": "#/definitions/SourceFileMapEntry"
791790
}
792791
]
793792
},
@@ -888,15 +887,14 @@
888887
"default": false
889888
},
890889
"processId": {
890+
"markdownDescription": "%c_cpp.debuggers.processId.anyOf.markdownDescription%",
891891
"anyOf": [
892892
{
893893
"type": "string",
894-
"description": "%c_cpp.debuggers.processId.anyOf.description%",
895894
"default": "${command:pickProcess}"
896895
},
897896
{
898897
"type": "integer",
899-
"description": "%c_cpp.debuggers.processId.anyOf.description%",
900898
"default": 0
901899
}
902900
]
@@ -912,17 +910,16 @@
912910
"default": false
913911
},
914912
"sourceFileMap": {
913+
"markdownDescription": "%c_cpp.debuggers.sourceFileMap.markdownDescription%",
915914
"anyOf": [
916915
{
917916
"type": "object",
918-
"description": "%c_cpp.debuggers.sourceFileMap.description%",
919917
"default": {
920918
"<source-path>": "<target-path>"
921919
}
922920
},
923921
{
924-
"$ref": "#/definitions/SourceFileMapEntry",
925-
"description": "%c_cpp.debuggers.sourceFileMap.sourceFileMapEntry.description%"
922+
"$ref": "#/definitions/SourceFileMapEntry"
926923
}
927924
]
928925
},
@@ -999,7 +996,7 @@
999996
},
1000997
"stopAtEntry": {
1001998
"type": "boolean",
1002-
"description": "%c_cpp.debuggers.stopAtEntry.description%",
999+
"markdownDescription": "%c_cpp.debuggers.stopAtEntry.markdownDescription%",
10031000
"default": false
10041001
},
10051002
"dumpPath": {
@@ -1036,7 +1033,7 @@
10361033
},
10371034
"sourceFileMap": {
10381035
"type": "object",
1039-
"description": "%c_cpp.debuggers.sourceFileMap.description%",
1036+
"markdownDescription": "%c_cpp.debuggers.sourceFileMap.markdownDescription%",
10401037
"default": {
10411038
"<source-path>": "<target-path>"
10421039
}
@@ -1111,15 +1108,14 @@
11111108
"default": ""
11121109
},
11131110
"processId": {
1111+
"markdownDescription": "%c_cpp.debuggers.processId.anyOf.markdownDescription%",
11141112
"anyOf": [
11151113
{
11161114
"type": "string",
1117-
"description": "%c_cpp.debuggers.processId.anyOf.description%",
11181115
"default": "${command:pickProcess}"
11191116
},
11201117
{
11211118
"type": "integer",
1122-
"description": "%c_cpp.debuggers.processId.anyOf.description%",
11231119
"default": 0
11241120
}
11251121
]
@@ -1131,7 +1127,7 @@
11311127
},
11321128
"sourceFileMap": {
11331129
"type": "object",
1134-
"description": "%c_cpp.debuggers.sourceFileMap.description%",
1130+
"markdownDescription": "%c_cpp.debuggers.sourceFileMap.markdownDescription%",
11351131
"default": {
11361132
"<source-path>": "<target-path>"
11371133
}

0 commit comments

Comments
 (0)