diff options
| author | Øyvind Harboe <oyvind.harboe@zylin.com> | 2010-09-27 22:55:30 +0200 |
|---|---|---|
| committer | Øyvind Harboe <oyvind.harboe@zylin.com> | 2010-10-01 10:26:10 +0200 |
| commit | 96a56ba086ec94e577e4b3562010710abb2087c6 (patch) | |
| tree | 77a87937ea11f785bd44a5f5ca974c3a84f274e2 /src/server | |
| parent | 50d5441e2a615fb2c44b41a777e4373901f7a2e6 (diff) | |
| download | openocd_libswd-96a56ba086ec94e577e4b3562010710abb2087c6.tar.gz openocd_libswd-96a56ba086ec94e577e4b3562010710abb2087c6.tar.bz2 openocd_libswd-96a56ba086ec94e577e4b3562010710abb2087c6.tar.xz openocd_libswd-96a56ba086ec94e577e4b3562010710abb2087c6.zip | |
pipes: add documentation for pipes
Stick with the name "gdb_port" even if this command
can be used for other things(disable, named pipes,
anonymous stdin/out pipe). "port" is correct for
probably more than 90% of use cases, if not more.
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
Diffstat (limited to 'src/server')
| -rw-r--r-- | src/server/gdb_server.c | 10 | ||||
| -rw-r--r-- | src/server/tcl_server.c | 2 | ||||
| -rw-r--r-- | src/server/telnet_server.c | 2 |
3 files changed, 9 insertions, 5 deletions
diff --git a/src/server/gdb_server.c b/src/server/gdb_server.c index 7026ff21..51809026 100644 --- a/src/server/gdb_server.c +++ b/src/server/gdb_server.c @@ -2545,9 +2545,13 @@ static const struct command_registration gdb_command_handlers[] = { .name = "gdb_port", .handler = handle_gdb_port_command, .mode = COMMAND_ANY, - .help = "Display or specify base port on which to listen " - "for incoming GDB connections. " - "No arguments reports GDB port; zero disables.", + .help = "Normally gdb listens to a TCP/IP port. Each subsequent GDB " + "server listens for the next port number after the " + "base port number specified. " + "No arguments reports GDB port. \"pipe\" means listen to stdin " + "output to stdout, an integer is base port number, \"disable\" disables " + "port. Any other string is are interpreted as named pipe to listen to. " + "Output pipe is the same name as input pipe, but with 'o' appended.", .usage = "[port_num]", }, { diff --git a/src/server/tcl_server.c b/src/server/tcl_server.c index 613eb23f..16710860 100644 --- a/src/server/tcl_server.c +++ b/src/server/tcl_server.c @@ -183,7 +183,7 @@ static const struct command_registration tcl_command_handlers[] = { .mode = COMMAND_CONFIG, .help = "Specify port on which to listen " "for incoming Tcl syntax. " - "No arguments reports Tcl port; zero disables.", + "Read help on 'gdb_port'.", .usage = "[port_num]", }, COMMAND_REGISTRATION_DONE diff --git a/src/server/telnet_server.c b/src/server/telnet_server.c index 00b4b5d2..98e86160 100644 --- a/src/server/telnet_server.c +++ b/src/server/telnet_server.c @@ -619,7 +619,7 @@ static const struct command_registration telnet_command_handlers[] = { .mode = COMMAND_ANY, .help = "Specify port on which to listen " "for incoming telnet connections. " - "No arguments reports telnet port; zero disables.", + "Read help on 'gdb_port'.", .usage = "[port_num]", }, COMMAND_REGISTRATION_DONE |