From patchwork Fri May 27 13:21:28 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Eli Zaretskii X-Patchwork-Id: 12564 Received: (qmail 65517 invoked by alias); 27 May 2016 13:21:39 -0000 Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Unsubscribe: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org Delivered-To: mailing list gdb-patches@sourceware.org Received: (qmail 65496 invoked by uid 89); 27 May 2016 13:21:38 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-2.8 required=5.0 tests=AWL, BAYES_00, RP_MATCHES_RCVD, SPF_PASS autolearn=ham version=3.3.2 spammy=@item, responses, HX-HELO:eggs.gnu.org, Hx-spam-relays-external:208.118.235.92 X-HELO: eggs.gnu.org Received: from eggs.gnu.org (HELO eggs.gnu.org) (208.118.235.92) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with (AES256-SHA encrypted) ESMTPS; Fri, 27 May 2016 13:21:28 +0000 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1b6Hhb-0007HZ-8G for gdb-patches@sourceware.org; Fri, 27 May 2016 09:21:26 -0400 Received: from fencepost.gnu.org ([2001:4830:134:3::e]:53571) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1b6Hhb-0007Gq-5E; Fri, 27 May 2016 09:21:23 -0400 Received: from 84.94.185.246.cable.012.net.il ([84.94.185.246]:3380 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_128_CBC_SHA1:128) (Exim 4.82) (envelope-from ) id 1b6HhY-00062w-Vs; Fri, 27 May 2016 09:21:21 -0400 Date: Fri, 27 May 2016 16:21:28 +0300 Message-Id: <8360tz1vs7.fsf@gnu.org> From: Eli Zaretskii To: Pedro Alves CC: dtaylor@emc.com, gdb-patches@sourceware.org In-reply-to: <5625464e-c351-27f3-9fca-d6cd22303118@redhat.com> (message from Pedro Alves on Fri, 27 May 2016 09:55:03 +0100) Subject: Re: [PATCH] Document short responses to qXfer:object:read. Reply-to: Eli Zaretskii References: <25526.1464294807@usendtaylorx2l> <83k2if290w.fsf@gnu.org> <5625464e-c351-27f3-9fca-d6cd22303118@redhat.com> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 2001:4830:134:3::e X-IsSubscribed: yes > Cc: gdb-patches@sourceware.org > From: Pedro Alves > Date: Fri, 27 May 2016 09:55:03 +0100 > > On 05/27/2016 09:35 AM, Eli Zaretskii wrote: > > > Finally, it looks to me that we should move the description of the > > responses to precede the details of the 'read' requests, since the > > list of those requests is very long, and thus the promised description > > of the responses "below" is very far away, which IMO gets in the way > > of reading and comprehending the issue. > > Fully agreed. The patch for that is below; OK? diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog index 34b9527..3abec90 100644 --- a/gdb/doc/ChangeLog +++ b/gdb/doc/ChangeLog @@ -1,3 +1,8 @@ +2016-05-27 Eli Zaretskii + + * gdb.texinfo (General Query Packets): Move the description of the + response before the long list of the specific 'read' 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 8f1ad4e..9310365 100644 --- a/gdb/doc/gdb.texinfo +++ b/gdb/doc/gdb.texinfo @@ -37251,9 +37251,40 @@ 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 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 @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,37 +37489,6 @@ @end table -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 - @item qXfer:@var{object}:write:@var{annex}:@var{offset}:@var{data}@dots{} @cindex write data into object, remote request @anchor{qXfer write}