Re: [doc patch] gdbserver.1: Document all the options and --multi

Jan Kratochvil
2013-04-06T06:47:33Z

On Sat, 06 Apr 2013 08:16:51 +0200, Eli Zaretskii wrote:
> > +@table @env
> > +
> > +@item gdbserver @var{comm} @var{prog} [@var{args}@dots{}]
> > +For the @var{comm} parameter see below, then supply name of the program to
> > +debug; the remote @value{GDBN} will do everything else. Any remaining
> > +arguments will be passed to the program verbatim.
> > +
> > +@item gdbserver --attach @var{comm} @var{pid}
> > +For the @var{comm} parameter see below, then supply @var{pid} of a running
> > +program; @value{GDBN} will do everything else.
> > +
> > +@item gdbserver --multi @var{comm}
> > +For the @var{comm} parameter see below; @value{GDBN} can then instruct
> > +@command{gdbserver} which command(s) to run.
> > +
> > +@end table
> > +
> > +The @var{comm} parameter is either a device name (to use a serial line),
> > +or a TCP portnumber (string @code{:1234}), or @code{-} or @code{stdio} to use
> > +stdin/stdout of @code{gdbserver}.
>
> This is OK, but perhaps will be even better if you describe the last
> mode first. Then you can put the description of @var{comm} there, and
> in the other 2 modes say something like "In addition to @var{comm} as
> above, supply ...".

I do not think it would be good, (1) the --multi mode is IMO an unusual one,
a special case and (2) I also tried to generally keep the "gdbserver --help"
output order.

Thanks,
Jan