From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wm1-f51.google.com (mail-wm1-f51.google.com [209.85.128.51]) by sourceware.org (Postfix) with ESMTPS id 955713849AC4 for ; Mon, 22 Apr 2024 19:01:20 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 955713849AC4 Authentication-Results: sourceware.org; dmarc=none (p=none dis=none) header.from=palves.net Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=gmail.com ARC-Filter: OpenARC Filter v1.0.0 sourceware.org 955713849AC4 Authentication-Results: server2.sourceware.org; arc=none smtp.remote-ip=209.85.128.51 ARC-Seal: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1713812482; cv=none; b=qjWBHNzQ8MC07Us7u5sJnMZfyJprxokhSwPyLA6fgKl42XQiiPas1iO09Bm9sbheCB8loKmdzhIX3qs42+XURrHw8XstJWFBQS127iT6QJui/9UmM3K9LZsE/uTo0J7akkAhQJYlN/HPCf5c/x5WsXAv79WVNR3t3ppL3qj/Ass= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1713812482; c=relaxed/simple; bh=67t+/VxR6iU1nr3dsces2LuvorXyJycJ5vSujdepGKQ=; h=Message-ID:Date:MIME-Version:Subject:To:From; b=r0xni/qQxY1zIbktlL48Ary6U2sSchj4/X1TZ8JMhuuu6jkYWtd7DSHTkFEBm7KAphs6fMklkuIveTCP3wfpueK70hr3a9ERxmbkS4FWoQ97J+sc5rx89/hAgQS5O4m1/tDmBh7OY+ZU6Zm+ajQ46WHfJeJ1uXlkirMv2vVJYZc= ARC-Authentication-Results: i=1; server2.sourceware.org Received: by mail-wm1-f51.google.com with SMTP id 5b1f17b1804b1-4196c62bb4eso23375765e9.2 for ; Mon, 22 Apr 2024 12:01:20 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1713812479; x=1714417279; h=content-transfer-encoding:in-reply-to:content-language:from :references:cc:to:subject:user-agent:mime-version:date:message-id :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=deEXe/7g4Cq9T0iEMam2Am6Czb/s4KgwEazV1uongdc=; b=pMkL79LrwNoXL3ozy/HuDAoykisxxZ1Q8pENan+FmsmDWLS+Izq2xVYR4VnhFhGOx6 xaP+nBYIzVQBf9cWlOHggFfR2AR0pW8f2TrrT7QrFU5KJyA83cxEl7/aV2XjGdZsVBl5 dtG7XZ3exgpUGpwSrrilU+rD1ZdrykJbEoTlFwu2zBy6IOzVRWJC1DLl10jFce46DbVW abtLUMbIfDe/E/L9OqkMmWqK5WSwiLD7V4vwpm/QUEg/LK1VgsU9YR6V7M9F3ftP2Yr6 iiSLVFJMJolwhxXId22LrElHwTQFHD4MESIFr2bARSGgxx2NkZAIDW8hsdwaYX8YkTjX Cv9Q== X-Gm-Message-State: AOJu0Yxw9qs6KJ5EG998jZSbjDXfkyQ0mTlViXoIQ3OTCAYt5vExOqm3 ujVrKxA6DNHyx9HMCTlW/G99v1N+eIUjwhwfbgAeJ55D2eeCgHRvAf887kTJ X-Google-Smtp-Source: AGHT+IEfU+JvF1UjUHba6xPpako0Jgcz5LUNuLM2H8s/rCM+dshsSFZc74C0+DowJpN6kY32ydqVCw== X-Received: by 2002:a05:600c:3c95:b0:419:ec38:f34b with SMTP id bg21-20020a05600c3c9500b00419ec38f34bmr6202807wmb.20.1713812479011; Mon, 22 Apr 2024 12:01:19 -0700 (PDT) Received: from ?IPV6:2001:8a0:f93d:b900:8880:21cb:6a55:2a43? ([2001:8a0:f93d:b900:8880:21cb:6a55:2a43]) by smtp.gmail.com with ESMTPSA id t13-20020a05600c450d00b00417f700eaeasm17693058wmo.22.2024.04.22.12.01.18 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Mon, 22 Apr 2024 12:01:18 -0700 (PDT) Message-ID: Date: Mon, 22 Apr 2024 20:01:17 +0100 MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH 01/12] Document conventions for describing packet syntax To: Eli Zaretskii Cc: gdb-patches@sourceware.org, jimb@codesourcery.com, mike_wrighton@mentor.com, nathan@codesourcery.com, abidh@codesourcery.com References: <20240419151342.1592474-1-pedro@palves.net> <20240419151342.1592474-2-pedro@palves.net> <867cgtbcih.fsf@gnu.org> From: Pedro Alves Content-Language: en-US In-Reply-To: <867cgtbcih.fsf@gnu.org> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Spam-Status: No, score=-4.3 required=5.0 tests=BAYES_00,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM,HEADER_FROM_DIFFERENT_DOMAINS,KAM_DMARC_STATUS,KAM_SHORT,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,SPF_HELO_NONE,SPF_PASS,TXREP autolearn=no autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org List-Id: Hi! On 2024-04-19 16:25, Eli Zaretskii wrote: >> From: Pedro Alves >> Cc: Jim Blandy , >> Mike Wrighton , >> Nathan Sidwell , >> Hafiz Abid Qadeer >> Date: Fri, 19 Apr 2024 16:13:31 +0100 >> >> This comment documents conventions for describing packet syntax in the >> Overview section. > > Thanks. > >> +We place optional portions of a packet in @r{[}square brackets@r{]}; > > This should be in @samp, otherwise the @r parts are redundant and > won't have any effect. > Hmm, if I wrap that in @samp, then it renders as: We place optional portions of a packet in '[square brackets]'; for example, a template like ‘c [addr]’ describes a packet beginning with the single ASCII character ‘c’, possibly followed by an addr. Those '' around [square brackets] seem off to me there. The original author must have wanted the rendered text without the single quotes too, since they didn't use @samp and they certainly looked at the rendered output back then. So given @r are nops, I think we should just remove them. That results in: We place optional portions of a packet in [square brackets]; for example, a template like ‘c [addr]’ describes a packet beginning with the single ASCII character ‘c’, possibly followed by an addr. which IMHO looks better. If you dislike that, I noticed that: https://www.gnu.org/software/texinfo/manual/texinfo/html_node/Command-List.html says: Square brackets, [ ], indicate optional arguments We could switch to a similar wording. I kind of like the original better, but this is a very tiny detail, of course. Let me know what you think. Pedro Alves >> +for example, a template like @samp{c @r{[}@var{addr}@r{]}} describes a >> +packet beginning with the single ASCII character @samp{c}, possibly >> +followed by an @var{addr}. > > OK with this nit fixed. > > Approved-By: Eli Zaretskii >