[Lldb-commits] [lldb] [lldb-dap][docs] Improve README (PR #109266)

[John Harrison via lldb-commits]

================
@@ -204,12 +171,67 @@ The default hostname being used `localhost`.
 }
 ```
 
-## Custom debugger commands
+### Configuration Settings Reference
+
+For both launch and attach configurations, lldb-dap accepts the following `lldb-dap`
+specific key/value pairs:
+
+|parameter          |type|req |         |
+|-------------------|----|:--:|---------|
+|**name**           |string|Y| A configuration name that will be displayed in the IDE.
+|**type**           |string|Y| Must be "lldb-dap".
+|**request**        |string|Y| Must be "launch" or "attach".
+|**program**        |string|Y| Path to the executable to launch.
+|**sourcePath**     |string| | Specify a source path to remap \"./\" to allow full paths to be used when setting breakpoints in binaries that have relative source paths.
+|**sourceMap**      |[string[2]]| | Specify an array of path re-mappings. Each element in the array must be a two element array containing a source and destination pathname. Overrides sourcePath.
+|**debuggerRoot**   | string| |Specify a working directory to use when launching lldb-dap. If the debug information in your executable contains relative paths, this option can be used so that `lldb-dap` can find source files and object files that have relative paths.
+|**commandEscapePrefix** | string | | The escape prefix to use for executing regular LLDB commands in the Debug Console, instead of printing variables. Defaults to a back-tick (`\``). If it's an empty string, then all expression in the Debug Console are treated as regular LLDB commands.
+|**customFrameFormat** | string | | If non-empty, stack frames will have descriptions generated based on the provided format. See https://lldb.llvm.org/use/formatting.html for an explanation on format strings for frames. If the format string contains errors, an error message will be displayed on the Debug Console and the default frame names will be used. This might come with a performance cost because debug information might need to be processed to generate the description.
+|**customThreadFormat** | string | | Same as `customFrameFormat`, but for threads instead of stack frames.
+|**initCommands**   |[string]| | LLDB commands executed upon debugger startup prior to creating the LLDB target.
----------------
ashgti wrote:

One feature that isn't document here is that commands can use a `!` (https://github.com/llvm/llvm-project/blob/main/lldb/tools/lldb-dap/LLDBUtils.cpp#L34) or `?` (https://github.com/llvm/llvm-project/blob/main/lldb/tools/lldb-dap/LLDBUtils.cpp#L31) prefix that adjusts command behavior slightly. 

`?` is quiet on success, i.e. the if the command succeeds then nothing is written to stdout.

`!` is to check for an error and stop running the commands if it fails, so if one of the commands depends on another this will stop the chain of commands.

https://github.com/llvm/llvm-project/pull/109266