This is the mail archive of the
mailing list for the GDB project.
Re: [RFA] Make first and last lines of 'command help documentation' consistent.
- From: Pedro Alves <palves at redhat dot com>
- To: Tom Tromey <tom at tromey dot com>, Philippe Waroquiers <philippe dot waroquiers at skynet dot be>
- Cc: gdb-patches at sourceware dot org
- Date: Thu, 11 Jul 2019 13:53:31 +0100
- Subject: Re: [RFA] Make first and last lines of 'command help documentation' consistent.
- References: <firstname.lastname@example.org> <email@example.com> <firstname.lastname@example.org> <email@example.com>
On 7/11/19 1:22 PM, Tom Tromey wrote:
>>>>>> "Philippe" == Philippe Waroquiers <firstname.lastname@example.org> 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.
Could this be a warning at command-registration-time instead? That
way you would see if as soon as the command is registered. And it'd
be hard to introduce a regression with build-in commands since
everyone would start seeing a warning.