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] Enhance break command help


> Date: Thu, 01 Dec 2005 16:54:31 +0000
> From: Andrew STUBBS <andrew.stubbs@st.com>
> 
> Andrew Stubbs wrote:
> > The attached patch adds more information to the on-line help for the 
> > break command. It adds a brief description how to set thread specific 
> > and conditional breakpoints.
> 
> I forgot to update the testsuite to expect the new help text.
> 
> Updated patch attached.

Okay for the breakpoint.c patch, thanks.  I have only one comment:
please remove all the "The" articles before argument names, like this:

  +LOCATION may be a line number, function name, or \"*\" and an address.\n\

instead of

  +The LOCATION may be a line number, function name, or \"*\" and an address.\n\

Also, can I ask you for a small favor?  There are other *break and
similar commands defined in breakpoint.c, whose doc strings reference
those of other commands and eventually the one you fixed.  I never
liked those references: the user shouldn't need to look up several
commands she doesn't care about to arrive at the required info.  So
could you please modify all those other doc strings to simply repeat
the arguments' description you just fixed?

Also, I see that some of those doc strings don't always leave 2 blanks
after a period that ends a sentence; please fix that as well.

Only if you have time for this, of course.  TIA


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