This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [PATCH 1/3] gdb: Switch "info types" over to use the gdb::options framework
> Date: Fri, 19 Jul 2019 15:50:48 +0100
> From: Andrew Burgess <andrew.burgess@embecosm.com>
> Cc: gdb-patches@sourceware.org
>
> > > +The optional flag @samp{-q}, which stands for @samp{quiet}, disables
> > > +printing header information.
> >
> > I don't see "headers" described anywhere in the preceding text, so
> > "disables printing header information" here is not clear enough.
> > Besides, the command's doc string says "some headers and messages",
> > which seems to imply more than just "headers" is suppressed by this
> > switch.
> >
> > Can you please make the effect of this switch more clear?
>
> Thanks for your feedback.
>
> Part of the problem here is that many of the commands in this area are
> similarly poorly documented, and I more or less copied the description
> over.
>
> I've simplified the command help text to actually reflect reality
> (only headers are suppressed) and extended the manual text to mention
> the headers before describing that the -q flag disables them.
>
> Hopefully this all makes more sense.
Yes, the text is clear now. Thanks.