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 /doc | |
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 'doc')
-rw-r--r-- | doc/openocd.texi | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/openocd.texi b/doc/openocd.texi index 3adc33a3..47951c6d 100644 --- a/doc/openocd.texi +++ b/doc/openocd.texi @@ -1721,17 +1721,17 @@ In such cases, just specify the relevant port number as zero. If you disable all access through TCP/IP, you will need to use the command line @option{-pipe} option. -@deffn {Command} gdb_port (number) +@deffn {Command} gdb_port [number] @cindex GDB server Specify or query the first port used for incoming GDB connections. The GDB port for the first target will be gdb_port, the second target will listen on gdb_port + 1, and so on. When not specified during the configuration stage, the port @var{number} defaults to 3333. -When specified as zero, this port is not activated. +When specified as zero, GDB remote access ports are not activated. @end deffn -@deffn {Command} tcl_port (number) +@deffn {Command} tcl_port [number] Specify or query the port used for a simplified RPC connection that can be used by clients to issue TCL commands and get the output from the Tcl engine. @@ -1741,7 +1741,7 @@ the port @var{number} defaults to 6666. When specified as zero, this port is not activated. @end deffn -@deffn {Command} telnet_port (number) +@deffn {Command} telnet_port [number] Specify or query the port on which to listen for incoming telnet connections. This port is intended for interaction with one human through TCL commands. |