[all-commits] [llvm/llvm-project] a4c8e3: [lldb][docs] Document what a Platform is (#202332)

[David Spickett via All-commits]

  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: a4c8e3dd883cbaa61c75fef25bf496bb3bd3350a
      https://github.com/llvm/llvm-project/commit/a4c8e3dd883cbaa61c75fef25bf496bb3bd3350a
  Author: David Spickett <david.spickett at arm.com>
  Date:   2026-06-10 (Wed, 10 Jun 2026)

  Changed paths:
    M lldb/docs/resources/lldbplatformpackets.md
    M lldb/docs/resources/overview.md

  Log Message:
  -----------
  [lldb][docs] Document what a Platform is (#202332)

Fixes #201875.

In #201875 a user was understandably confused what a platform even is,
and I had never had to explain it from the conceptual point of view
either.

So I wrote a long explanation
(https://github.com/llvm/llvm-project/issues/201875#issuecomment-4634087717)
specific to what they were trying to do. I don't think we need all that
in the docs and we don't have a great place for it anyway.

My alternative is:
* A high level explanation in the overview, to say what a platform does.
* A link from there to https://lldb.llvm.org/use/remote.html which has a
practical example of using one.
* A note in the platform extensions doc that our platform mode is not
related to gdb's extended remote.

It should be possible to locate all that from website search, and
failing that, lldb experts will be able to find it and link to it in
future discussions.



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