diff options
| author | David Brownell <dbrownell@users.sourceforge.net> | 2010-01-09 00:55:41 -0800 |
|---|---|---|
| committer | David Brownell <dbrownell@users.sourceforge.net> | 2010-01-09 00:55:41 -0800 |
| commit | fc9a2d0e6f3270dc86f84749ad10dd79d97c8392 (patch) | |
| tree | 1c0c8a706ab6fee0f098ec6118a72c9057e33e85 /src/server/tcl_server.c | |
| parent | aafd3877e6fbc1745dbfc5d4f54a2c7efe8cc3d6 (diff) | |
| download | openocd+libswd-fc9a2d0e6f3270dc86f84749ad10dd79d97c8392.tar.gz openocd+libswd-fc9a2d0e6f3270dc86f84749ad10dd79d97c8392.tar.bz2 openocd+libswd-fc9a2d0e6f3270dc86f84749ad10dd79d97c8392.tar.xz openocd+libswd-fc9a2d0e6f3270dc86f84749ad10dd79d97c8392.zip | |
src/server: usage/help/doc updates
Make "usage" messages use the same EBNF as the User's Guide;
no angle brackets. Improve and correct various helptexts.
Specifically for the port commands, clarify that the number
is optional, and omitting it causes the current number to be
displayed.
Don't use "&function"; a function's name is its address.
Remove a couple instances of pointless whitespace; shrink a
few overlong lines.
Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
Diffstat (limited to 'src/server/tcl_server.c')
| -rw-r--r-- | src/server/tcl_server.c | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/src/server/tcl_server.c b/src/server/tcl_server.c index a772c0ac..a88c4365 100644 --- a/src/server/tcl_server.c +++ b/src/server/tcl_server.c @@ -181,11 +181,12 @@ COMMAND_HANDLER(handle_tcl_port_command) static const struct command_registration tcl_command_handlers[] = { { .name = "tcl_port", - .handler = &handle_tcl_port_command, + .handler = handle_tcl_port_command, .mode = COMMAND_CONFIG, - .help = "port on which to listen " - "for incoming TCL syntax", - .usage = "<port>", + .help = "Specify port on which to listen " + "for incoming Tcl syntax. " + "No arguments reports Tcl port; zero disables.", + .usage = "[port_num]", }, COMMAND_REGISTRATION_DONE }; |