From patchwork Thu Jun 14 20:31:18 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Philippe Waroquiers X-Patchwork-Id: 27859 Received: (qmail 69591 invoked by alias); 14 Jun 2018 20:31:37 -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 69370 invoked by uid 89); 14 Jun 2018 20:31:24 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-26.0 required=5.0 tests=AWL, BAYES_00, GIT_PATCH_0, GIT_PATCH_1, GIT_PATCH_2, GIT_PATCH_3, RCVD_IN_DNSWL_LOW, SPF_PASS autolearn=ham version=3.3.2 spammy=UD:be, HX-Envelope-From:sk:philipp, H*F:D*be, H*M:2365 X-HELO: mailsec119.isp.belgacom.be Received: from mailsec119.isp.belgacom.be (HELO mailsec119.isp.belgacom.be) (195.238.20.115) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Thu, 14 Jun 2018 20:31:21 +0000 X-IronPort-Anti-Spam-Filtered: true X-IronPort-Anti-Spam-Result: =?us-ascii?q?A2CeAQAj0CJb/+ApQFddHAEBAQQBAQoBA?= =?us-ascii?q?YNIQoEfKIMyR4gEX41yMQGUO4F4CysBhEACgkgiNBgBAgEBAQEBAQIBbCiCNSQ?= =?us-ascii?q?Bgk8BBSMPASMzCAECGAICJgICOR4GARKFJ45Im0eCHIRcg2yBaIELiRU/gQ+DD?= =?us-ascii?q?IQ+gziCVQKMOYxVBwKBao0XjTiRQYFBOIFSbYMWkFE9MIENCAwBjFmCSAEB?= X-IPAS-Result: =?us-ascii?q?A2CeAQAj0CJb/+ApQFddHAEBAQQBAQoBAYNIQoEfKIMyR4g?= =?us-ascii?q?EX41yMQGUO4F4CysBhEACgkgiNBgBAgEBAQEBAQIBbCiCNSQBgk8BBSMPASMzC?= =?us-ascii?q?AECGAICJgICOR4GARKFJ45Im0eCHIRcg2yBaIELiRU/gQ+DDIQ+gziCVQKMOYx?= =?us-ascii?q?VBwKBao0XjTiRQYFBOIFSbYMWkFE9MIENCAwBjFmCSAEB?= Received: from 224.41-64-87.adsl-dyn.isp.belgacom.be (HELO md) ([87.64.41.224]) by relay.skynet.be with ESMTP/TLS/AES256-GCM-SHA384; 14 Jun 2018 22:31:18 +0200 Message-ID: <1529008278.2365.4.camel@skynet.be> Subject: Re: [RFA] Fix/improve on-line help of 'define' command. From: Philippe Waroquiers To: Simon Marchi , gdb-patches@sourceware.org Date: Thu, 14 Jun 2018 22:31:18 +0200 In-Reply-To: <3ea57d42-da87-c109-104f-9b2ac6db3fc8@ericsson.com> References: <20180604213136.32395-1-philippe.waroquiers@skynet.be> <3ea57d42-da87-c109-104f-9b2ac6db3fc8@ericsson.com> Mime-Version: 1.0 X-IsSubscribed: yes On Wed, 2018-06-13 at 07:19 -0400, Simon Marchi wrote: > On 2018-06-04 05:31 PM, Philippe Waroquiers wrote: > > While I was playing with 'define' to understand how some quoting was > > done (or not done), I found an inconsistency between the doc > > and the online help. > > => the doc is correct, so fixing/improving the on-line help. > > > > 2018-06-04 Philippe Waroquiers > > > > * cli/cli-script.c (_initialize_cli_script): Fix online documentation > > of 'define' command. > > --- > > gdb/cli/cli-script.c | 3 ++- > > 1 file changed, 2 insertions(+), 1 deletion(-) > > > > diff --git a/gdb/cli/cli-script.c b/gdb/cli/cli-script.c > > index 72de8ec1c7..8ceecdf435 100644 > > --- a/gdb/cli/cli-script.c > > +++ b/gdb/cli/cli-script.c > > @@ -1602,7 +1602,8 @@ Define a new command name. Command name is argument.\n\ > > Definition appears on following lines, one command per line.\n\ > > End with a line of just \"end\".\n\ > > Use the \"document\" command to give documentation for the new command.\n\ > > -Commands defined in this way may have up to ten arguments.")); > > +Commands defined in this way may accept an unlimited number of arguments\n\ > > +accessed via $arg0 .. $argN. $argc tells how many arguments have been passed.")); > > Two spaces after period, keep the length <= 80 columns. Otherwise, LGTM. Thanks. I fixed the 2 things above, and pushed the below. Philippe diff --git a/gdb/ChangeLog b/gdb/ChangeLog index 8150685e5c..60766ca777 100644 --- a/gdb/ChangeLog +++ b/gdb/ChangeLog @@ -1,3 +1,8 @@ +2018-06-14  Philippe Waroquiers   + +       * cli/cli-script.c (_initialize_cli_script): Fix online documentation +       of 'define' command. +  2018-06-14  Tom de Vries             PR cli/22573 diff --git a/gdb/cli/cli-script.c b/gdb/cli/cli-script.c index 72de8ec1c7..87ebf9fc00 100644 --- a/gdb/cli/cli-script.c +++ b/gdb/cli/cli-script.c @@ -1602,7 +1602,9 @@ Define a new command name.  Command name is argument.\n\  Definition appears on following lines, one command per line.\n\  End with a line of just \"end\".\n\  Use the \"document\" command to give documentation for the new command.\n\ -Commands defined in this way may have up to ten arguments.")); +Commands defined in this way may accept an unlimited number of arguments\n\ +accessed via $arg0 .. $argN.  $argc tells how many arguments have\n\ +been passed."));      add_com ("while", class_support, while_command, _("\  Execute nested commands WHILE the conditional expression is non zero.\n\