From c185ba27ca74b02bcca8d016e2d82b09aa6df28b Mon Sep 17 00:00:00 2001 From: Eli Zaretskii Date: Fri, 27 May 2016 16:59:22 +0300 Subject: [PATCH] Improve documentation of general query packets gdb/doc/ChangeLog: * gdb.texinfo (General Query Packets): Move the description of the response before the long list of the specific 'read' and 'write' requests. --- gdb/doc/ChangeLog | 6 +++ gdb/doc/gdb.texinfo | 102 ++++++++++++++++++++++---------------------- 2 files changed, 57 insertions(+), 51 deletions(-) diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog index 34b9527366c..9ed044b76f9 100644 --- a/gdb/doc/ChangeLog +++ b/gdb/doc/ChangeLog @@ -1,3 +1,9 @@ +2016-05-27 Eli Zaretskii + + * gdb.texinfo (General Query Packets): Move the description of the + response before the long list of the specific 'read' and 'write' + requests. + 2016-05-23 Tom Tromey * python.texi (Basic Python): Document gdb.breakpoints return. diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo index 8f1ad4ee36c..7e89003345f 100644 --- a/gdb/doc/gdb.texinfo +++ b/gdb/doc/gdb.texinfo @@ -37251,9 +37251,40 @@ 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. -Here are the specific requests of this form defined so far. All +Reply: +@table @samp +@item m @var{data} +Data @var{data} (@pxref{Binary Data}) has been read from the +target. There may be more data at a higher address (although +it is permitted to return @samp{m} even for the last valid +block of data, as long as at least one byte of data was read). +It is possible for @var{data} to have fewer bytes than the @var{length} in the +request. + +@item l @var{data} +Data @var{data} (@pxref{Binary Data}) has been read from the target. +There is no more data to be read. It is possible for @var{data} to +have fewer bytes than the @var{length} in the request. + +@item l +The @var{offset} in the request is at the end of the data. +There is no more data to be read. + +@item E00 +The request was malformed, or @var{annex} was invalid. + +@item E @var{nn} +The offset was invalid, or there was an error encountered reading the data. +The @var{nn} part is a hex-encoded @code{errno} value. + +@item @w{} +An empty reply indicates the @var{object} string was not recognized by +the stub, or that the object does not support reading. +@end table + +Here are the specific requests of this form defined so far. All the @samp{qXfer:@var{object}:read:@dots{}} requests use the same reply -formats, listed below. +formats, listed above. @table @samp @item qXfer:auxv:read::@var{offset},@var{length} @@ -37458,50 +37489,37 @@ Access the target's @dfn{operating system information}. @end table +@item qXfer:@var{object}:write:@var{annex}:@var{offset}:@var{data}@dots{} +@cindex write data into object, remote request +@anchor{qXfer write} +Write uninterpreted bytes into the target's special data area +identified by the keyword @var{object}, starting at @var{offset} bytes +into the data. The binary-encoded data (@pxref{Binary Data}) to be +written is given by @var{data}@dots{}. The content and encoding of @var{annex} +is specific to @var{object}; it can supply additional details about what data +to access. + Reply: @table @samp -@item m @var{data} -Data @var{data} (@pxref{Binary Data}) has been read from the -target. There may be more data at a higher address (although -it is permitted to return @samp{m} even for the last valid -block of data, as long as at least one byte of data was read). -It is possible for @var{data} to have fewer bytes than the @var{length} in the -request. - -@item l @var{data} -Data @var{data} (@pxref{Binary Data}) has been read from the target. -There is no more data to be read. It is possible for @var{data} to -have fewer bytes than the @var{length} in the request. - -@item l -The @var{offset} in the request is at the end of the data. -There is no more data to be read. +@item @var{nn} +@var{nn} (hex encoded) is the number of bytes written. +This may be fewer bytes than supplied in the request. @item E00 The request was malformed, or @var{annex} was invalid. @item E @var{nn} -The offset was invalid, or there was an error encountered reading the data. +The offset was invalid, or there was an error encountered writing the data. The @var{nn} part is a hex-encoded @code{errno} value. @item @w{} -An empty reply indicates the @var{object} string was not recognized by -the stub, or that the object does not support reading. +An empty reply indicates the @var{object} string was not +recognized by the stub, or that the object does not support writing. @end table -@item qXfer:@var{object}:write:@var{annex}:@var{offset}:@var{data}@dots{} -@cindex write data into object, remote request -@anchor{qXfer write} -Write uninterpreted bytes into the target's special data area -identified by the keyword @var{object}, starting at @var{offset} bytes -into the data. The binary-encoded data (@pxref{Binary Data}) to be -written is given by @var{data}@dots{}. The content and encoding of @var{annex} -is specific to @var{object}; it can supply additional details about what data -to access. - -Here are the specific requests of this form defined so far. All +Here are the specific requests of this form defined so far. All the @samp{qXfer:@var{object}:write:@dots{}} requests use the same reply -formats, listed below. +formats, listed above. @table @samp @item qXfer:siginfo:write::@var{offset}:@var{data}@dots{} @@ -37526,24 +37544,6 @@ This packet is not probed by default; the remote stub must request it, by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}). @end table -Reply: -@table @samp -@item @var{nn} -@var{nn} (hex encoded) is the number of bytes written. -This may be fewer bytes than supplied in the request. - -@item E00 -The request was malformed, or @var{annex} was invalid. - -@item E @var{nn} -The offset was invalid, or there was an error encountered writing the data. -The @var{nn} part is a hex-encoded @code{errno} value. - -@item @w{} -An empty reply indicates the @var{object} string was not -recognized by the stub, or that the object does not support writing. -@end table - @item qXfer:@var{object}:@var{operation}:@dots{} Requests of this form may be added in the future. When a stub does not recognize the @var{object} keyword, or its support for -- 2.30.2