[all-commits] [llvm/llvm-project] 65c570: [lldb-dap][docs] Improve README (#109266)

Adrian Vogelsgesang via All-commits all-commits at lists.llvm.org
Fri Sep 20 13:18:40 PDT 2024


  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: 65c57066e099fe7f1357485cd6c4fb068bc82323
      https://github.com/llvm/llvm-project/commit/65c57066e099fe7f1357485cd6c4fb068bc82323
  Author: Adrian Vogelsgesang <avogelsgesang at salesforce.com>
  Date:   2024-09-20 (Fri, 20 Sep 2024)

  Changed paths:
    M lldb/tools/lldb-dap/README.md

  Log Message:
  -----------
  [lldb-dap][docs] Improve README (#109266)

* Document how to procure and configure the `lldb-dap` binary
* Improve documentation for `launch.json`:
* Show the examples before the reference. Most new users just want to
get going, and will only need the reference later on
   * Deduplicate the list of "launch" and "attach" config settings
* Remove the `stopOnEntry` setting from "attach", since this is a
launch-only setting
* Document the previously undocumented settings `sourcePath`,
`commandEscapePrefix`, `custom{Frame,Thread}Format`, `runInTerminal`
* Add the settings `debuggerRoot` and `sourceMap` to the common section.
So far they were documented as launch-only settings.
* Document that the Debug Console prints variables / expressions by
default and that LLDB commands need to be escaped.



To unsubscribe from these emails, change your notification settings at https://github.com/llvm/llvm-project/settings/notifications


More information about the All-commits mailing list