From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by sourceware.org (Postfix) with ESMTPS id 3FB33385840B for ; Mon, 29 Apr 2024 13:42:41 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 3FB33385840B Authentication-Results: sourceware.org; dmarc=pass (p=none dis=none) header.from=redhat.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=redhat.com ARC-Filter: OpenARC Filter v1.0.0 sourceware.org 3FB33385840B Authentication-Results: server2.sourceware.org; arc=none smtp.remote-ip=170.10.133.124 ARC-Seal: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1714398163; cv=none; b=tXK2lXHhJ1dSA87p4B6swJd4jNU2cum6v9W01YimAZAkDE5ZPj3eM2YhxHZk5ypfmScjeK1Gq7Msake00bqKIcfDTpPTqnhJIHtC+LupRDc4dQTR8NccXUCN+0ZVgOTzupzsBTbDynjG6vUTkF/OyOA/DJu33xIu/2ZndMyxIrg= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1714398163; c=relaxed/simple; bh=aEB4cJUdiH8vi8EBs01GQBa1OHYpyKR8zBMt+3V3ENo=; h=DKIM-Signature:From:To:Subject:Date:Message-ID:MIME-Version; b=CxWogkkqCRdHCoGKbjUejx9wn2xNff4MP1zO0p9QLLy8gHyJUQ8IFSyMccXWqZBb+a2poVtzJgUnoKrccS3tJraNY1VyCfd31g0MTRDT3JVMV+WDa7HrBwLddhlLV4+YECvRDN3ff6dHBJ08gkJ/XC58T41RxK2VQHAKnwTDxpE= ARC-Authentication-Results: i=1; server2.sourceware.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1714398160; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=x4Co9u6ydQhhDHTQjC77xm45jyC63wX7Hd2o0jQnj1w=; b=SRQBnV059NGC94ATEX9H8qk2ow46jadWb0THsAbMFWdE7ztxvcCWQxiC9+eympoIg32k8G DKGAl2tV9PIYFEh/q8fBXAFLJtYZtABqxIND8HC/XpcfEJzloEjQTU39t9RHSNh69mzN8q L5UKSj+tQy6J4ON/+kiWgU74X/4gl0I= Received: from mail-wm1-f72.google.com (mail-wm1-f72.google.com [209.85.128.72]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-206-W7chVJOnP4qmr017xp0d1A-1; Mon, 29 Apr 2024 09:42:39 -0400 X-MC-Unique: W7chVJOnP4qmr017xp0d1A-1 Received: by mail-wm1-f72.google.com with SMTP id 5b1f17b1804b1-41c01902e60so7212185e9.3 for ; Mon, 29 Apr 2024 06:42:38 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1714398158; x=1715002958; h=content-transfer-encoding:mime-version:message-id:date:references :in-reply-to:subject:to:from:x-gm-message-state:from:to:cc:subject :date:message-id:reply-to; bh=YbUrQ1OeIZWXfsb5yggfOpM0w3pc1zUyxWARt6w25hg=; b=YkIWkPEKeP9D6lTOGHCySPna1mFZX6+DBuB8FAOeMw0mZktPh0a9myCcitFx0xW1VA oSeRYOrTlEgdSZ4KeVEM7ArmkMBXTD7uwzf7q8Ng3uMim615M3neYxQ4ZgVSXTQ1e+4k iV75SGJ+HyZ1qn8X4W/e9SYIQeFUUkSKoDCKQzTE0Qd78IrmLBen4cu2VbeWr/ApNvWd 5KIYs24IRbakjTGyBoXAYW6Ht1TMx8dIGrn66J4Ct4MhSw5hdftvFdEIxNAASww9p3jB /ojB+qt0A04Cm31bKW6hIqU/bMv4g3FB9MbotA7LqAUZNaop9joubHEKmjbCkJfPt6lr 4MPw== X-Forwarded-Encrypted: i=1; AJvYcCWeQXtWepE6c/U6Zq+OgdO1K2HEGyF1A/D/vyA38tfimME/9Gyyx3wTeYZa5nmuXDPn8FoFeGUEfCqiMMMXZugJ0zb/ls5Gzb6PlQ== X-Gm-Message-State: AOJu0Yyb3euIB0x6MoP92lPumtZWDf+q8VeksN3V69QTQGQJUfLxxMAS pWZwFdjy7pXRl8XVPeTbbjqXgVQ/mstjULlDCm1Dl2BWiQF96MhfYAHYH6/h0wHZCnyRfPyHAG1 +TU4vZHe1z5HSLvQkiugUchHIxRTn6YoIAKQLBHF2S6OPuYxIWhNBhULG9C0= X-Received: by 2002:a05:600c:4751:b0:41b:f116:87e0 with SMTP id w17-20020a05600c475100b0041bf11687e0mr4854857wmo.29.1714398157495; Mon, 29 Apr 2024 06:42:37 -0700 (PDT) X-Google-Smtp-Source: AGHT+IGOucDdrCl1PYatKMDj1IjfcPj02gX0ocUT9MLPHsDV6Z0WzFxHE/DpCxxr71+w8qxtFhBh0w== X-Received: by 2002:a05:600c:4751:b0:41b:f116:87e0 with SMTP id w17-20020a05600c475100b0041bf11687e0mr4854835wmo.29.1714398156901; Mon, 29 Apr 2024 06:42:36 -0700 (PDT) Received: from localhost (185.223.159.143.dyn.plus.net. [143.159.223.185]) by smtp.gmail.com with ESMTPSA id v10-20020a05600c470a00b0041bfa349cadsm7369840wmo.16.2024.04.29.06.42.36 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 29 Apr 2024 06:42:36 -0700 (PDT) From: Andrew Burgess To: Pedro Alves , gdb-patches@sourceware.org, Eli Zaretskii Subject: Re: [PATCH 03/12] Document "E.MESSAGE" RSP errors In-Reply-To: <91568db8-32c2-42e0-b34f-8acb3f93cee1@palves.net> References: <20240419151342.1592474-1-pedro@palves.net> <20240419151342.1592474-4-pedro@palves.net> <878r15hjbz.fsf@redhat.com> <3b156aac-556b-47eb-a1c7-f20071aa9a8f@palves.net> <91568db8-32c2-42e0-b34f-8acb3f93cee1@palves.net> Date: Mon, 29 Apr 2024 14:42:35 +0100 Message-ID: <874jbkp9o4.fsf@redhat.com> MIME-Version: 1.0 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Spam-Status: No, score=-12.2 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH,DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,GIT_PATCH_0,KAM_LOTSOFHASH,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H4,RCVD_IN_MSPIKE_WL,SPF_HELO_NONE,SPF_NONE,TXREP autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org List-Id: Pedro Alves writes: > [Adding Eli.] > > AFAICT, this is the only patch left in the series that needs an OK. Thanks for updating the docs. I'm happy with this. Reviewed-By: Andrew Burgess Thanks, Andrew > > Any comments on the updated documentation change below? > > Pedro Alves > > On 2024-04-22 20:04, Pedro Alves wrote: >> On 2024-04-22 09:50, Andrew Burgess wrote: >>=20 >>>> diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo >>>> index 57260a5b2fa..d6184d52841 100644 >>>> --- a/gdb/doc/gdb.texinfo >>>> +++ b/gdb/doc/gdb.texinfo >>>> @@ -42557,6 +42557,10 @@ number. In almost all cases, the protocol do= es not specify the >>>> meaning of the error numbers; @value{GDBN} usually ignores the >>>> numbers, or displays them to the user without further interpretation. >>>> =20 >>>> +@item @samp{E.@var{message}} >>>> +An error has occurred; @var{message} is the textual error message, >>>> +encoded in @sc{ascii}. >>> >>> I think we should document here that the 'qRcmd' and 'm' packets don't >>> accept this reply format. >>> >>> Alexandra H=C3=A1jkov=C3=A1 has a patch series which has not been poste= d yet which >>> will extend these packets in a backward compatible way so that E.messag= e >>> can be used, but until that arrives we should probably document this >>> limitation. >>=20 >> Done, see updated patch below. (See the bottom of the new commit log.) >>=20 >> Not sure when we'd want to make GDB print the error for the 'm' packet, >> though. Currently it just returns TARGET_XFER_E_IO up to the caller. >>=20 >> I noticed a few packets were documenting an "E.errtext" response, >> which I now removed in this version. Then "E.errtext" seemed more >> descriptive than "E.message", so I switched to that too. >>=20 >>=20 >> From 36ef5ca67f515039bfa68d2fb2515f181629a24f Mon Sep 17 00:00:00 2001 >> From: Pedro Alves >> Date: Thu, 18 Apr 2024 20:22:36 +0100 >> Subject: [PATCH] Document "E.MESSAGE" RSP errors >>=20 >> For many years, GDB has accepted a "E.MESSAGE" error response, in >> addition to "E NN". For many packets, GDB strips the "E." before >> giving the error message to the user. For others, GDB does not strip >> the "E.", but still understands that it is an error, as it starts with >> "E", and either prints the whole string, or ignores it and just >> mentions an error occured (same as for "E NN"). >>=20 >> This has been the case for as long as I remember. Now that I check, I >> see that it's been there since 2006 (commit a76d924dffcb, also here: >> https://sourceware.org/pipermail/gdb-patches/2006-September/047286.html)= . >> All along, I actually thought it was documented. Turns out it wasn't. >>=20 >> This commit documents it, in the new "Standard Replies" section, near >> where we document "E NN". >>=20 >> The original version of this 3-patch documentation series was a single >> CodeSourcery patch that documented the textual error as >> "E.NAME.MESSAGE", with MESSAGE being 8-bit binary encoded. But I >> think the ship has sailed for that. GDBserver has been sending error >> messages with more than one "." for a long while, and with no binary >> encoding. Still, I've preserved the "Co-Authored-By" list of the >> original larger patch. >>=20 >> The 'qRcmd' and 'm' commands are exceptions and do not accept this >> reply format. The top of the "Standard Replies" section already says: >>=20 >> "All commands support these, except as noted in the individual >> command descriptions." >>=20 >> So this adds a note to the description of 'qRcmd' and 'm', explicitly >> stating that they do not support this error reply format. >>=20 >> Change-Id: Ie4fee3d00d82ede39e439bf162e8cb7485532fd8 >> Co-Authored-By: Jim Blandy >> Co-Authored-By: Mike Wrighton >> Co-Authored-By: Nathan Sidwell >> Co-Authored-By: Hafiz Abid Qadeer >> --- >> gdb/doc/gdb.texinfo | 23 +++++++++++++---------- >> 1 file changed, 13 insertions(+), 10 deletions(-) >>=20 >> diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo >> index 9781ce76226..f55ada29e9c 100644 >> --- a/gdb/doc/gdb.texinfo >> +++ b/gdb/doc/gdb.texinfo >> @@ -42559,6 +42559,11 @@ number. In almost all cases, the protocol does= not specify the >> meaning of the error numbers; @value{GDBN} usually ignores the >> numbers, or displays them to the user without further interpretation. >> =20 >> +@anchor{textual error reply} >> +@item @samp{E.@var{errtext}} >> +An error has occurred; @var{errtext} is the textual error message, >> +encoded in @sc{ascii}. >> + >> @end table >> =20 >> @node Packets >> @@ -42885,6 +42890,10 @@ The reply may contain fewer addressable memory = units than requested if the >> server was able to read only part of the region of memory. >> @end table >> =20 >> +Unlike most packets, this packet does not support >> +@samp{E.@var{errtext}}-style textual error replies (@pxref{textual >> +error reply}). >> + >> @item M @var{addr},@var{length}:@var{XX@dots{}} >> @cindex @samp{M} packet >> Write @var{length} addressable memory units starting at address @var{ad= dr} >> @@ -44399,6 +44408,10 @@ A command response with no output. >> A command response with the hex encoded output string @var{OUTPUT}. >> @end table >> =20 >> +Unlike most packets, this packet does not support >> +@samp{E.@var{errtext}}-style textual error replies (@pxref{textual >> +error reply}). >> + >> (Note that the @code{qRcmd} packet's name is separated from the >> command by a @samp{,}, not a @samp{:}, contrary to the naming >> conventions above. Please don't use this packet as a model for new >> @@ -45455,8 +45468,6 @@ Reply: >> @table @samp >> @item OK >> Branch tracing has been enabled. >> -@item E.errtext >> -A badly formed request or an error was encountered. >> @end table >> =20 >> @item Qbtrace:pt >> @@ -45466,8 +45477,6 @@ Reply: >> @table @samp >> @item OK >> Branch tracing has been enabled. >> -@item E.errtext >> -A badly formed request or an error was encountered. >> @end table >> =20 >> @item Qbtrace:off >> @@ -45477,8 +45486,6 @@ Reply: >> @table @samp >> @item OK >> Branch tracing has been disabled. >> -@item E.errtext >> -A badly formed request or an error was encountered. >> @end table >> =20 >> @item Qbtrace-conf:bts:size=3D@var{value} >> @@ -45489,8 +45496,6 @@ Reply: >> @table @samp >> @item OK >> The ring buffer size has been set. >> -@item E.errtext >> -A badly formed request or an error was encountered. >> @end table >> =20 >> @item Qbtrace-conf:pt:size=3D@var{value} >> @@ -45501,8 +45506,6 @@ Reply: >> @table @samp >> @item OK >> The ring buffer size has been set. >> -@item E.errtext >> -A badly formed request or an error was encountered. >> @end table >> =20 >> @end table >>=20 >> base-commit: 0e6747d2a638693ad2f20e7929c8364913c87279 >> prerequisite-patch-id: 69a7241ff790954e07942cd212971bcfaa8f3a08 >> prerequisite-patch-id: b398b6e111b68e06adccda7d9e016ebe39b5fd35