From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wm1-f45.google.com (mail-wm1-f45.google.com [209.85.128.45]) by sourceware.org (Postfix) with ESMTPS id D18223857BB1 for ; Tue, 31 May 2022 13:04:03 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org D18223857BB1 Authentication-Results: sourceware.org; dmarc=none (p=none dis=none) header.from=palves.net Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=gmail.com Received: by mail-wm1-f45.google.com with SMTP id 129-20020a1c0287000000b003974edd7c56so1211469wmc.2 for ; Tue, 31 May 2022 06:04:03 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:message-id:date:mime-version:user-agent:subject :content-language:to:cc:references:from:in-reply-to :content-transfer-encoding; bh=oZbccI6b8Qrj+HgFTXsXGpkyDDJBhhblqahpgGac+FI=; b=1g5mbklXQqPNO9YLDgwjzyUmZQQBOGJbv2XTvhxwNnqOiUEPI8OqM4DRLdaeAB1PHh WzYv3x4Qy0PM1fk5RI2o+AaZNX31BP+G2AZprLF5JO+Q1DRgaKU/x9qFrV6nKl9oz8xo k/F7iWqULpsAlVf6BxXuGCysGmHJhYcDjlwxY/rhmLa5eYa+ZbZGOHkrA1UohWnsR+vj kHpr9eomOL6heNmigdOIly0KNlPx6sp4pC3brU8M9xLKAy0rxGHtCvk0joliND3QHTsW FSgz7sYNdlLVBEug4VKt289sjrKcObBceBtp54CkbJd3zARcCf+vDyvAC5hoVJCAXDjx cDnQ== X-Gm-Message-State: AOAM533c5B5CFC05xd/rxedu5XsCLLDdZMBPSGoeau3jbB69d2EqQCF+ xkcTZg85+Vz8OTdVCqJIuIUPLwBwqkI= X-Google-Smtp-Source: ABdhPJzxAZkNKK2vvcA7v1dB+zHsF6H24LkiczKEi5e29XkCiormutooOckBsNusnp+Im7ue1qTO2Q== X-Received: by 2002:a05:600c:1992:b0:397:8d3b:8a9b with SMTP id t18-20020a05600c199200b003978d3b8a9bmr18813203wmq.20.1654002242780; Tue, 31 May 2022 06:04:02 -0700 (PDT) Received: from ?IPV6:2001:8a0:f924:2600:209d:85e2:409e:8726? ([2001:8a0:f924:2600:209d:85e2:409e:8726]) by smtp.gmail.com with ESMTPSA id k11-20020a7bc40b000000b003974b80a98bsm2089701wmi.26.2022.05.31.06.04.01 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Tue, 31 May 2022 06:04:01 -0700 (PDT) Message-ID: <3c77c9b4-9984-0a71-c6fc-04fc707b6b07@palves.net> Date: Tue, 31 May 2022 14:04:00 +0100 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Thunderbird/91.9.1 Subject: Re: [PATCH] Improve clear command's documentation Content-Language: en-US To: Eli Zaretskii Cc: gdb-patches@sourceware.org References: <20220526194250.2310460-1-pedro@palves.net> <838rqmm7gb.fsf@gnu.org> <6914f754-4e33-5aa1-4ea6-dca9504e8bfe@palves.net> <837d63j8tx.fsf@gnu.org> <83k0a1j2ur.fsf@gnu.org> From: Pedro Alves In-Reply-To: <83k0a1j2ur.fsf@gnu.org> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit X-Spam-Status: No, score=-5.3 required=5.0 tests=BAYES_00, FREEMAIL_FORGED_FROMDOMAIN, FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS, KAM_DMARC_STATUS, NICE_REPLY_A, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H2, SPF_HELO_NONE, SPF_PASS, TXREP, T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org X-BeenThere: gdb-patches@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gdb-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 31 May 2022 13:04:05 -0000 On 2022-05-31 13:36, Eli Zaretskii wrote: >> Date: Tue, 31 May 2022 12:05:53 +0100 >> Cc: gdb-patches@sourceware.org >> From: Pedro Alves >> >> How about this, basically a complete rewrite of the clear command's >> documentation: > > Thanks, the idea to rewrite it is indeed a good one. But the actual > text IMO came out highly repetitive, and has several markup issues. > Rather than commenting on each issue, I suggest the following reworded > text: > > @item clear @var{locspec} > Delete any breakpoint whose code location corresponds to > @var{locspec}. @xref{Location Specifications}, for the various forms > of @var{locspec}. Which code locations correspond to @var{locspec} > depends on the form used in the location specifications @var{locspec}: > > @table @code > @item @var{linenum} > @itemx @var{filename}:@var{linenum} > @itemx -line @var{linenum} > @itemx -source @var{filename} -line @var{linenum} > If @var{locspec} specifies a line number, with or without a file > name, the command deletes any breakpoint whose code location is > at or within the specified line @var{linenum} in files that match the > specified @var{filename}. If @var{filename} is omitted, it defaults > to the current source file. > > @item *@var{address} > If @var{locspec} specifies an address, the command deletes any > breakpoint whose code location is at the given @var{address}. > > @item @var{function} > @itemx -function @var{function} > If @var{locspec} specifies a function, the command deletes any > breakpoint whose code location is at the entry to any function whose > name matches @var{function}. > @end table > > Ambiguity in names of files and functions can be resolved as > described in @ref{Location Specifications}. > > WDYT? > I like this a lot. Will you merge it, or shall I?