Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Philippe Waroquiers <philippe.waroquiers@skynet.be>
To: Simon Marchi <simon.marchi@ericsson.com>, gdb-patches@sourceware.org
Subject: Re: [RFA] Fix/improve on-line help of 'define' command.
Date: Thu, 14 Jun 2018 20:31:00 -0000	[thread overview]
Message-ID: <1529008278.2365.4.camel@skynet.be> (raw)
In-Reply-To: <3ea57d42-da87-c109-104f-9b2ac6db3fc8@ericsson.com>

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  <philippe.waroquiers@skynet.be>
> > 
> > 	* 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  <philippe.waroquiers@skynet.be>
+
+       * cli/cli-script.c (_initialize_cli_script): Fix online documentation
+       of 'define' command.
+
 2018-06-14  Tom de Vries  <tdevries@suse.de>
 
        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\



      reply	other threads:[~2018-06-14 20:31 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-06-04 21:31 Philippe Waroquiers
2018-06-12 21:58 ` Philippe Waroquiers
2018-06-13 11:19 ` Simon Marchi
2018-06-14 20:31   ` Philippe Waroquiers [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1529008278.2365.4.camel@skynet.be \
    --to=philippe.waroquiers@skynet.be \
    --cc=gdb-patches@sourceware.org \
    --cc=simon.marchi@ericsson.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox