diff mbox

Document short responses to qXfer:object:read.

Message ID 22941.1464286237@usendtaylorx2l
State New
Headers show

Commit Message

David Taylor May 26, 2016, 6:10 p.m. UTC
[We have a copyright assignment on file (in case it matters -- but, this
is short enough that I doubt it is is copyrightable).]

This is a follow up to my May 9th posting (subject: qXfer:threads:read
packets) on the gdb mailing list.  This only addresses the short
response part, not the dtd vs documentation discrepancy.

 gdb/doc/ChangeLog   | 5 +++++
 gdb/doc/gdb.texinfo | 5 +++++
 2 files changed, 10 insertions(+)

Comments

Eli Zaretskii May 26, 2016, 7:31 p.m. UTC | #1
> From: David Taylor <dtaylor@emc.com>
> cc: dtaylor@emc.com
> Date: Thu, 26 May 2016 14:10:37 -0400
> 
> +2016-05-26  David Taylor  <dtaylor@emc.com>
> +
> +	* gdb.texinfo (General Query Packets): Document treatment of short
> +	qXfer responses and EOF indication.
> +
>  2016-05-23  Tom Tromey  <tom@tromey.com>
>  
>  	* python.texi (Basic Python): Document gdb.breakpoints return.
> diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
> index 8f1ad4e..c674c7a 100644
> --- a/gdb/doc/gdb.texinfo
> +++ b/gdb/doc/gdb.texinfo
> @@ -37251,6 +37251,11 @@ starting at @var{offset} bytes into the data.  The content and
>  encoding of @var{annex} is specific to @var{object}; it can supply
>  additional details about what data to access.
>  
> +The target is permitted to return a short response.  The response is
> +considered to cover the range @var{offset} (inclusive) to @var{offset}
> ++ @var{response length} (exclusive).  End of file is indicated by a
> +zero length response.
> +
>  Here are the specific requests of this form defined so far.  All
>  @samp{qXfer:@var{object}:read:@dots{}} requests use the same reply
>  formats, listed below.

Thanks.  However, I have difficulty understanding what this text is
trying to convey.  Problematic words are "permitted" and "short" --
they don't seem to be related to anything around this text, and are
not explained by the text itself.  I also don't see why EOF is
important here, or even related.

Could you perhaps explain in your own words what is this about, and
what the text lacks without this paragraph?  I might then propose a
more clear wording.

Thanks.
diff mbox

Patch

diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index 34b9527..b46075f 100644
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -1,3 +1,8 @@ 
+2016-05-26  David Taylor  <dtaylor@emc.com>
+
+	* gdb.texinfo (General Query Packets): Document treatment of short
+	qXfer responses and EOF indication.
+
 2016-05-23  Tom Tromey  <tom@tromey.com>
 
 	* python.texi (Basic Python): Document gdb.breakpoints return.
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 8f1ad4e..c674c7a 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -37251,6 +37251,11 @@  starting at @var{offset} bytes into the data.  The content and
 encoding of @var{annex} is specific to @var{object}; it can supply
 additional details about what data to access.
 
+The target is permitted to return a short response.  The response is
+considered to cover the range @var{offset} (inclusive) to @var{offset}
++ @var{response length} (exclusive).  End of file is indicated by a
+zero length response.
+
 Here are the specific requests of this form defined so far.  All
 @samp{qXfer:@var{object}:read:@dots{}} requests use the same reply
 formats, listed below.