This is the mail archive of the gdb-patches@sourceware.org mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [patch] Implement set/show callback functions in gdb.Parameter


> From: Phil Muldoon <pmuldoon@redhat.com>
> Cc: tromey@redhat.com, gdb-patches@sourceware.org
> Date: Mon, 07 Mar 2011 20:37:06 +0000
> 
> >> +@defop Operation {parameter} get_set_string self
> >> +@value{GDBN} will call this method when a parameter has been
> >> +invoked via the @code{set} API (for example, @kbd{set foo off}).  The
> >
> > Calling an operation a "parameter" is not the best idea.  Already you
> > need to talk about "invoking a parameter", which sounds awkward.  Can
> > we find a better word here?
> 
> 
> Well this is an operation in a gdb.Parameter.  Not sure what else to
> call it.  What do you think?

Then how about rephrasing the description like this:

  @value{GDBN} will call this method when @var{parameter}'s value has
  been changed via the @code{set} API (for example, @kbd{set foo off}).

Would this be accurate?

For the get_show_string, I would suggest

  @value{GDBN} will call this method when @var{parameter}'s
  @code{show} API has been invoked (for example, @kbd{show foo}).

WDYT?


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]