[RFA] add note on command naming to gdbint.texi

[RFA] add note on command naming to gdbint.texi

[Doug Evans]

Hi.

I'd like to add this to the Coding section of gdbint.texi.

Ok?

2010-06-03  Doug Evans  <dje@google.com>

	* gdbint.texinfo (Coding): Add subsection on command names.

Index: doc/gdbint.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdbint.texinfo,v
retrieving revision 1.323
diff -u -p -r1.323 gdbint.texinfo
--- doc/gdbint.texinfo	2 May 2010 23:52:14 -0000	1.323
+++ doc/gdbint.texinfo	3 Jun 2010 18:05:31 -0000
@@ -6245,6 +6245,10 @@ the code detected a user error, recovere
 @code{warning} or the code failed to correctly recover from the user
 error and issued an @code{internal_error}.}
 
+@subsection Command Names
+
+GDB U/I commands are written @samp{foo-bar}, not @samp{foo_bar}.
+
 @subsection File Names
 
 Any file used when building the core of @value{GDBN} must be in lower

Re: [RFA] add note on command naming to gdbint.texi

[Eli Zaretskii]

> Date: Thu,  3 Jun 2010 11:13:53 -0700 (PDT)
> From: dje@google.com (Doug Evans)
> 
> I'd like to add this to the Coding section of gdbint.texi.
> 
> Ok?

Fine with me, thanks.

Re: [RFA] add note on command naming to gdbint.texi

[Tom Tromey]

>>>>> "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 don't think that impacts whether this patch should go in.

Tom

Re: [RFA] add note on command naming to gdbint.texi

[Stan Shebs]

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