mbox series

[COMMITTED,v9,2.0/6] GDB: Add missing inline documentation for `add_setshow_cmd_full'

Message ID alpine.DEB.2.20.2301182157350.7841@tpp.orcam.me.uk
Headers
Series GDB: Add missing inline documentation for `add_setshow_cmd_full' |

Message

Maciej W. Rozycki Jan. 18, 2023, 11:24 p.m. UTC 
  On Thu, 12 Jan 2023, Simon Marchi wrote:

> > Index: src/gdb/cli/cli-decode.c
> > ===================================================================
> > --- src.orig/gdb/cli/cli-decode.c
> > +++ src/gdb/cli/cli-decode.c
> > @@ -580,6 +580,18 @@ add_setshow_cmd_full_erased (const char
> >    return {set, show};
> >  }
> >  
> > +/* Add element named NAME to both the command SET_LIST and SHOW_LIST.
> 
> "to both the command" doesn't really make sense.  I'd say "to both
> command lists SET_LIST and SHOW_LIST", or "to both lists SET_LIST and
> SHOW_LIST".
> 
> I see that this text comes from add_setshow_cmd_full_erased, it can be
> fixed there too.  Also, it would be fine to just document the duplicated
> parameters in one function and refer to that in the other function.

 Fair enough.  Indeed I have copied the sentence verbatim from the other 
place.  I have fixed this and applied as in this mini sub-series.  Thank 
you for your review.

  Maciej