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

Jonas Devlieghere via lldb-commits lldb-commits at lists.llvm.org
Fri Sep 20 11:09:22 PDT 2024


================
@@ -1,77 +1,30 @@
 # LLDB DAP
 
-## `lldb-dap` Configurations
+## Procuring the `lldb-dap` binary
 
-The extension requires the `lldb-dap` (formerly `lldb-vscode`) binary. It is a
-command line tool that implements the [Debug Adapter
-Protocol](https://microsoft.github.io/debug-adapter-protocol/). It is used to power the Visual Studio Code extension but can also be used with other IDEs and editors that support DAP.
-The protocol is easy to run remotely and also can allow other tools and IDEs to
-get a full featured debugger with a well defined protocol.
+The extension requires the `lldb-dap` (formerly `lldb-vscode`) binary.
+This binary is not packaged with the VS Code extension.
 
-## Launching & Attaching Configuration
+There are multiple ways to obtain this binary:
+* build it from source (see [LLDB's build instructions](https://lldb.llvm.org/resources/build.html))
+* download it one of the relase packages from the [LLVM release page](https://github.com/llvm/llvm-project/releases/). The `LLVM-19.1.0-{operating_system}.tar.xz` packages contain a prebuilt `lldb-dap` binary.
+* use the binary provided by your toolchain (for example `xcrun -f lldb-dap` on macOS) or contact your toolchain vendor to include it
----------------
JDevlieghere wrote:

Missing period.

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


More information about the lldb-commits mailing list