[v2,1/4] doc: fine-tune the documentation of the 'm' RSP packet
Checks
| Context |
Check |
Description |
| linaro-tcwg-bot/tcwg_gdb_build--master-arm |
success
|
Testing passed
|
| linaro-tcwg-bot/tcwg_gdb_check--master-arm |
success
|
Testing passed
|
| linaro-tcwg-bot/tcwg_gdb_build--master-aarch64 |
success
|
Testing passed
|
| linaro-tcwg-bot/tcwg_gdb_check--master-aarch64 |
success
|
Testing passed
|
Commit Message
Revise a sentence to avoid misinterpretation. Move @cindex entries
before the text they index. Refer to trace frames regarding partial
reads.
---
gdb/doc/gdb.texinfo | 13 +++++++------
1 file changed, 7 insertions(+), 6 deletions(-)
Comments
> From: Tankut Baris Aktemur <tankut.baris.aktemur@intel.com>
> Cc: tom@tromey.com
> Date: Thu, 14 Mar 2024 14:07:28 +0100
>
> Revise a sentence to avoid misinterpretation. Move @cindex entries
> before the text they index. Refer to trace frames regarding partial
> reads.
> ---
> gdb/doc/gdb.texinfo | 13 +++++++------
> 1 file changed, 7 insertions(+), 6 deletions(-)
Thanks, this is okay.
Approved-By: Eli Zaretskii <eliz@gnu.org>
@@ -42743,24 +42743,25 @@ probes the target state as if a new connection was opened
@item m @var{addr},@var{length}
@cindex @samp{m} packet
Read @var{length} addressable memory units starting at address @var{addr}
-(@pxref{addressable memory unit}). Note that @var{addr} may not be aligned to
-any particular boundary.
+(@pxref{addressable memory unit}). Note that @var{addr} does not have to
+be aligned to any particular boundary.
+@cindex alignment of remote memory accesses
+@cindex size of remote memory accesses
+@cindex memory, alignment and size of remote accesses
The stub need not use any particular size or alignment when gathering
data from memory for the response; even if @var{addr} is word-aligned
and @var{length} is a multiple of the word size, the stub is free to
use byte accesses, or not. For this reason, this packet may not be
suitable for accessing memory-mapped I/O devices.
-@cindex alignment of remote memory accesses
-@cindex size of remote memory accesses
-@cindex memory, alignment and size of remote accesses
Reply:
@table @samp
@item @var{XX@dots{}}
Memory contents; each byte is transmitted as a two-digit hexadecimal number.
The reply may contain fewer addressable memory units than requested if the
-server was able to read only part of the region of memory.
+server was reading from a trace frame memory and was able to read only part
+of the region of memory.
@item E @var{NN}
@var{NN} is errno
@end table