From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from eggs.gnu.org (eggs.gnu.org [IPv6:2001:470:142:3::10]) by sourceware.org (Postfix) with ESMTPS id 21F08384AB7E for ; Fri, 19 Apr 2024 15:36:28 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 21F08384AB7E Authentication-Results: sourceware.org; dmarc=pass (p=none dis=none) header.from=gnu.org Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=gnu.org ARC-Filter: OpenARC Filter v1.0.0 sourceware.org 21F08384AB7E Authentication-Results: server2.sourceware.org; arc=none smtp.remote-ip=2001:470:142:3::10 ARC-Seal: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1713540989; cv=none; b=PGOisze41pc+pnrREQY1xIxKzZ1oy+rxBsA2FI04/X9zpNezp03vowO+WKtW17Jeu+efdxf4pxsLSD4neQwBC2AVVd3ckQAielPTQ/mAPOlIP5fhpgR7ggIv2e76yXXHTXfsinLFMiIT6+oXOJaIROgsaHi84CfFjju7UqQUD0Y= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1713540989; c=relaxed/simple; bh=YU9rbPQ1sIloSc7Hd3W0it7xtoKuZc8Ai1W9uUIkAmc=; h=DKIM-Signature:Date:Message-Id:From:To:Subject; b=wuOCLbcMeOo83nNRmXtloW38pTGpWUR2bpjbkqUFHbYdLCnvtflZRQlcFODNGC4QCnt7olb/yNTgy4BXr0n1Rib1Fgh4AYaxMjOOILEQyKYgEkrDbFJkoUDBLt0SzFXz22T2APqxDZHea7Ihvt93H2zLbaGGhvfxkqahbt4ZsK4= ARC-Authentication-Results: i=1; server2.sourceware.org Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rxqHq-0005Xh-Kf; Fri, 19 Apr 2024 11:36:26 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=3jDBv4VmARN0M36XTmpCQrRHNT+vljHrJPX/4wGz3PE=; b=Tp6MOPZ+ndvU +DGgcz9RCEPr8Z9AVLND00zJ1LYGw5YvPsvBjrq5TbH2jA3zhLuFVFHn8iSiRAE3T8j7bPHiozOxK Lnq0gz3woKmxQDfpY2srCD8Fy/YB3ff1uOBjoSA501HYeBvnvk+Za9700mbUc1IP4IMZyl1bfiD3l 4rMU+A5FHkcp1Re2IFQNJ554rJy+hK4t3AIAYCa+423VIv8CRWZfVIvFMfPD8NRrQzO+6hAHzBoqc V3RqSTCLitEWf8pYtOoz6wk/HY6DuAAAUQJEp2h2KBVAgQBkW148RO7IoQyhwOnArFyF8uT7eaXYf wag75pN6vgDdGL7X3Y13YA==; Date: Fri, 19 Apr 2024 18:36:04 +0300 Message-Id: <865xwdbc0r.fsf@gnu.org> From: Eli Zaretskii To: Pedro Alves Cc: gdb-patches@sourceware.org, jimb@codesourcery.com, mike_wrighton@mentor.com, nathan@codesourcery.com, abidh@codesourcery.com In-Reply-To: <20240419151342.1592474-3-pedro@palves.net> (message from Pedro Alves on Fri, 19 Apr 2024 16:13:32 +0100) Subject: Re: [PATCH 02/12] Centralize documentation of error and empty RSP responses References: <20240419151342.1592474-1-pedro@palves.net> <20240419151342.1592474-3-pedro@palves.net> X-Spam-Status: No, score=-0.9 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH,DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,SPF_HELO_PASS,SPF_PASS,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: > From: Pedro Alves > Cc: Jim Blandy , > Mike Wrighton , > Nathan Sidwell , > Hafiz Abid Qadeer > Date: Fri, 19 Apr 2024 16:13:32 +0100 > > gdb/doc/gdb.texinfo | 244 +++++++------------------------------------- > 1 file changed, 36 insertions(+), 208 deletions(-) Thanks. > +See @ref{Standard Replies} for standard error responses, and how to Please use @xref here instead of "See @ref", as that's what @xref is for. Also, some old versions of makeinfo insist on a period or comma after the closing brace (with the single exception of @pxref), so please add it. > +@node Standard Replies > +@section Standard Replies This section should have an index entry. I suggest @cindex standard responses for remote packets @cindex remote packets, standard replies > +@cindex empty response, for unsupported packets > +@cindex unsupported packets, empty response for > +For any @var{command} not supported by the stub, an empty response ^^^^^^^ "command", not "packet"? > +(@samp{$#00}) should be returned. I don't understand what you mean by $#00, and why that is considered and "empty response". I'm probably missing something. Also, "should be returned" doesn't really fit the purpose of this section, which AFAIU is to describe the standard responses. So something like below would be IMO more appropriate: An empty response means this packet is not supported by the stub. Reviewed-By: Eli Zaretskii