Updating the readme after renaming lldb-dap custom-event to lldb-dap send-event.

ashgti · ashgti · commit 6af7bc69ad14 · 2024-10-16T12:15:06.000-07:00
diff --git a/lldb/tools/lldb-dap/README.md b/lldb/tools/lldb-dap/README.md
@@ -290,30 +290,37 @@ The initial repl-mode can be configured with the cli flag `--repl-mode=<mode>`
 and may also be adjusted at runtime using the lldb command
 `lldb-dap repl-mode <mode>`.
 
-#### `lldb-dap custom-event`
+#### `lldb-dap send-event`
 
-lldb-dap includes a custom command to trigger a Debug Adapter Protocol event 
-from a script. [See the specification](https://microsoft.github.io/debug-adapter-protocol/specification#Base_Protocol_Event) 
-for more details on Debug Adapter Protocol events.
+lldb-dap includes a command to trigger a Debug Adapter Protocol event
+from a script.
+
+The event maybe a custom DAP event or a standard event, if the event is not 
+handled internally by `lldb-dap`.
 
 This command has the format:
 
 ```
-lldb-dap custom-event <name> <body>?
+lldb-dap send-event <name> <body>?
 ```
 
-For example you can use a launch configuration hook to run the command like:
+For example you can use a launch configuration hook to trigger custom events like:
 
 ```json
 {
   "program": "exe",
   "stopCommands": [
-    "lldb-dap custom-event MyStopEvent",
-    "lldb-dap custom-event MyStopEvent '{\"key\":321}",
+    "lldb-dap send-event MyStopEvent",
+    "lldb-dap send-event MyStopEvent '{\"key\": 321}",
   ]
 }
 ```
 
+[See the specification](https://microsoft.github.io/debug-adapter-protocol/specification#Base_Protocol_Event) 
+for more details on Debug Adapter Protocol events and the VS Code 
+[debug.onDidReceiveDebugSessionCustomEvent](https://code.visualstudio.com/api/references/vscode-api#debug.onDidReceiveDebugSessionCustomEvent) 
+API for handling a custom event from an extension.
+
 ## Contributing
 
 `lldb-dap` and `lldb` are developed under the umbrella of the [LLVM project](https://llvm.org/).
