Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Stan Shebs <stan@codesourcery.com>
To: tromey@redhat.com
Cc: Doug Evans <dje@google.com>, gdb-patches@sourceware.org
Subject: Re: [RFA] add note on command naming to gdbint.texi
Date: Thu, 03 Jun 2010 20:31:00 -0000	[thread overview]
Message-ID: <4C081113.2030201@codesourcery.com> (raw)
In-Reply-To: <m3y6evzz77.fsf@fleche.redhat.com>

Tom Tromey wrote:
>>>>>> "Doug" == Doug Evans <dje@google.com> writes:
>>>>>>             
>
> Doug> I'd like to add this to the Coding section of gdbint.texi.
>
> Doug> +GDB U/I commands are written @samp{foo-bar}, not @samp{foo_bar}.
>
> I wonder whether we also have a rule about when to use a hyphen versus
> when to use a subcommand.
>   

I think it's been semi-random to date (or is that "semi random"? :-) ).  
It would make sense to suggest using subcommands if there are going to 
be several related commands for which "foo" is a sensible name for the 
group.  It shouldn't be required though, since for instance the 
permissions patch I'm working on has commands "set may-write-registers" 
and "set may-insert-breakpoints", but "set may write-registers" is just 
going to be mystifying.

The suggestion should also mention the possibility of using "bar" as the 
common subcommand prefix, if the grouping is more logical or easier to 
remember that way.  For instance, I never used to remember whether it 
was "set remote-debug" or "set debug-remote", but "debug remote" is easy 
because now it's part of the debug group of set commands.

Stan


      reply	other threads:[~2010-06-03 20:31 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-06-03 18:14 Doug Evans
2010-06-03 18:44 ` Eli Zaretskii
2010-06-03 19:36 ` Tom Tromey
2010-06-03 20:31   ` Stan Shebs [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=4C081113.2030201@codesourcery.com \
    --to=stan@codesourcery.com \
    --cc=dje@google.com \
    --cc=gdb-patches@sourceware.org \
    --cc=tromey@redhat.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