[Lldb-commits] [lldb] [lldb][docs] Some fixes for lldbgdbremote.md. (PR #200079)
Prashanth Mundkur via lldb-commits
lldb-commits at lists.llvm.org
Thu May 28 09:08:18 PDT 2026
https://github.com/pmundkur updated https://github.com/llvm/llvm-project/pull/200079
>From 94048672fd55eb06c297090da70f9bc230f35366 Mon Sep 17 00:00:00 2001
From: Prashanth Mundkur <prashanth at riscv.org>
Date: Wed, 27 May 2026 18:30:31 -0500
Subject: [PATCH 1/3] [lldb][docs] Some fixes for lldbgdbremote.md.
This has the following fixes:
- fix a typo: `qAttachOrWaitSupported` -> `qVAttachOrWaitSupported`
- document that a response to `qHostInfo` can contain an `arch` key-value pair
- clarify that the value of the `triple` key is a hex encoded string
---
lldb/docs/resources/lldbgdbremote.md | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/lldb/docs/resources/lldbgdbremote.md b/lldb/docs/resources/lldbgdbremote.md
index 6e54f8eccf89d..e4a0842ae02fa 100644
--- a/lldb/docs/resources/lldbgdbremote.md
+++ b/lldb/docs/resources/lldbgdbremote.md
@@ -1259,7 +1259,7 @@ already has a thread selected (see the `Hg` packet from the standard
GDB remote protocol documentation) yet the remote GDB server actually
has another thread selected.
-## qAttachOrWaitSupported
+## qVAttachOrWaitSupported
This is a binary "is it supported" query. Return OK if you support
`vAttachOrWait`.
@@ -1312,7 +1312,7 @@ some key value pairs. The key value pairs in the command are:
be listed for all users, not just the user that the
platform is running as
* `triple` - `string` -
- An ASCII triple string (`x86_64`, `x86_64-apple-macosx`, `armv7-apple-ios`)
+ An hex encoded triple string (hex encodings of `x86_64`, `x86_64-apple-macosx`, `armv7-apple-ios`)
* `args` - `string` -
A string value containing the process arguments separated by the character `-`,
where each argument is hex-encoded. It includes `argv[0]`.
@@ -1396,9 +1396,10 @@ read packet: $cputype:16777223;cpusubtype:3;ostype:darwin;vendor:apple;endian:li
```
Key value pairs are one of:
+* `arch`: a string for the architecture, not needed if "triple" is specified
* `cputype`: is a number that is the mach-o CPU type that is being debugged (base 10)
* `cpusubtype`: is a number that is the mach-o CPU subtype type that is being debugged (base 10)
-* `triple`: a string for the target triple (x86_64-apple-macosx) that can be used to specify arch + vendor + os in one entry
+* `triple`: a hex encoded string for the target triple (x86_64-apple-macosx) that can be used to specify arch + vendor + os in one entry
* `vendor`: a string for the vendor (apple), not needed if "triple" is specified
* `ostype`: a string for the OS being debugged (macosx, linux, freebsd, ios, watchos), not needed if "triple" is specified
* `endian`: is one of "little", "big", or "pdp"
@@ -1702,7 +1703,7 @@ The key value pairs in the response are:
* `euid` - `integer` - A string value containing the decimal effective user ID
* `egid` - `integer` - A string value containing the decimal effective group ID
* `name` - `ascii-hex` - An ASCII hex string that contains the name of the process
-* `triple` - `string` - A target triple (`x86_64-apple-macosx`, `armv7-apple-ios`)
+* `triple` - `string` - A hex encoded target triple (hex encodings of `x86_64-apple-macosx`, `armv7-apple-ios`)
Sample packet/response:
```
>From 0e6870a897781fef9699a8458f849cd56f245c95 Mon Sep 17 00:00:00 2001
From: Prashanth Mundkur <prashanth at riscv.org>
Date: Thu, 28 May 2026 11:01:44 -0500
Subject: [PATCH 2/3] Add appropriate 'for example'; fix incorrect change for
send-side triple in q{fs}ProcessInfo.
---
lldb/docs/resources/lldbgdbremote.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/lldb/docs/resources/lldbgdbremote.md b/lldb/docs/resources/lldbgdbremote.md
index e4a0842ae02fa..e6270d6d8b9bd 100644
--- a/lldb/docs/resources/lldbgdbremote.md
+++ b/lldb/docs/resources/lldbgdbremote.md
@@ -1312,7 +1312,7 @@ some key value pairs. The key value pairs in the command are:
be listed for all users, not just the user that the
platform is running as
* `triple` - `string` -
- An hex encoded triple string (hex encodings of `x86_64`, `x86_64-apple-macosx`, `armv7-apple-ios`)
+ An ASCII triple string (for example `x86_64`, `x86_64-apple-macosx`, `armv7-apple-ios`)
* `args` - `string` -
A string value containing the process arguments separated by the character `-`,
where each argument is hex-encoded. It includes `argv[0]`.
@@ -1399,7 +1399,7 @@ Key value pairs are one of:
* `arch`: a string for the architecture, not needed if "triple" is specified
* `cputype`: is a number that is the mach-o CPU type that is being debugged (base 10)
* `cpusubtype`: is a number that is the mach-o CPU subtype type that is being debugged (base 10)
-* `triple`: a hex encoded string for the target triple (x86_64-apple-macosx) that can be used to specify arch + vendor + os in one entry
+* `triple`: a hex encoded string for the target triple (for example, hex encoding of `x86_64-apple-macosx`) that can be used to specify arch + vendor + os in one entry
* `vendor`: a string for the vendor (apple), not needed if "triple" is specified
* `ostype`: a string for the OS being debugged (macosx, linux, freebsd, ios, watchos), not needed if "triple" is specified
* `endian`: is one of "little", "big", or "pdp"
@@ -1703,7 +1703,7 @@ The key value pairs in the response are:
* `euid` - `integer` - A string value containing the decimal effective user ID
* `egid` - `integer` - A string value containing the decimal effective group ID
* `name` - `ascii-hex` - An ASCII hex string that contains the name of the process
-* `triple` - `string` - A hex encoded target triple (hex encodings of `x86_64-apple-macosx`, `armv7-apple-ios`)
+* `triple` - `string` - A hex encoded target triple (for example, hex encodings of `x86_64-apple-macosx`, `armv7-apple-ios`)
Sample packet/response:
```
>From f2805b7b6fafb3be627a8d1508a0d3542affbf6c Mon Sep 17 00:00:00 2001
From: Prashanth Mundkur <prashanth at riscv.org>
Date: Thu, 28 May 2026 11:06:27 -0500
Subject: [PATCH 3/3] Add a send-side triple for qfProcessInfo; and note the
asymmetry.
Co-authored-by: David Spickett <david.spickett at arm.com>
---
lldb/docs/resources/lldbgdbremote.md | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/lldb/docs/resources/lldbgdbremote.md b/lldb/docs/resources/lldbgdbremote.md
index e6270d6d8b9bd..3ad3d044aa234 100644
--- a/lldb/docs/resources/lldbgdbremote.md
+++ b/lldb/docs/resources/lldbgdbremote.md
@@ -1330,8 +1330,14 @@ send packet: $qsProcessInfo#00
read packet: $pid:59992;ppid:192;uid:7746;gid:11;euid:7746;egid:11;name:6d64776f726b6572;triple:x86_64-apple-macosx;#00
send packet: $qsProcessInfo#00
read packet: $E04#00
+send packet: $qfProcessInfo:name_match:contains;name:616263;all_users:0;triple:arm64-unknown-linux-gnu;#da
+read packet: $E03#a8
```
+Note that triples in this packet are normal strings, but triples
+received in response are hex encoded strings. This difference was
+unintentional but cannot be changed at this point.
+
**Priority To Implement:** Required
More information about the lldb-commits
mailing list