This is the mail archive of the 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: [RFA] Make first and last lines of 'command help documentation' consistent.

>>>>> "Pedro" == Pedro Alves <> writes:

Pedro> On 7/11/19 1:22 PM, Tom Tromey wrote:
>>>>>>> "Philippe" == Philippe Waroquiers <> writes:
>>>> I think this can't be an assertion, because user commands could hit it,
>>>> and that seems too harsh; but could it be a unit test?  That might be
>>>> better than printing something magic, especially since IIUC the user can
>>>> end up seeing this stuff.
Philippe> Effectively, the user can end up seeing this, but only if the GDB test
Philippe> was not run and/or was not fixed.
>> Or if there is any command written in Python or Guile that has a newline
>> at the end of its help text.  These commands can be supplied any number
>> of ways.

Pedro> Could this be a warning at command-registration-time instead?  That
Pedro> way you would see if as soon as the command is registered.  And it'd
Pedro> be hard to introduce a regression with build-in commands since
Pedro> everyone would start seeing a warning.

Where I was coming from is that this is a pretty minor cosmetic issue;
and while it makes sense for gdb to follow this rule, it isn't worth it
for 3rd party commands.  So, we should test gdb itself to avoid problems
here, but ignore problems coming from elsewhere.

I don't feel super strongly about it.


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