This is the mail archive of the gdb-patches@sourceware.org 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: [doc patch] gdbserver.1: Document all the options and --multi


> Date: Fri, 5 Apr 2013 22:20:33 +0200
> From: Jan Kratochvil <jan.kratochvil@redhat.com>
> Cc: gdb-patches@sourceware.org
> 
> +The three mode of executing @command{gdbserver} have the following options.
             ^^^^
"modes"

> +@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 ...".

No other comments, thanks.


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