aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMarc Schink <dev@zapb.de>2021-07-30 18:01:09 +0200
committerAntonio Borneo <borneo.antonio@gmail.com>2021-08-14 13:33:30 +0100
commit4a5045b143cad3b0bdba7c5590504bfc19e9a627 (patch)
treeb3639e9216b5c48d80780935581c5c64928a4fb2 /doc
parentdd04079c2c15bbdb0460342284c96812f4c78d87 (diff)
downloadriscv-openocd-4a5045b143cad3b0bdba7c5590504bfc19e9a627.zip
riscv-openocd-4a5045b143cad3b0bdba7c5590504bfc19e9a627.tar.gz
riscv-openocd-4a5045b143cad3b0bdba7c5590504bfc19e9a627.tar.bz2
drivers/remote_bitbang: Group adapter commands
Use a command group 'remote_bitbang' with subcommands instead of individual commands with 'remote_bitbang_' prefix. The old commands are still available for backward compatibility but marked as deprecated. Change-Id: I2692320f19c8a357112a365db6ca7e13cd6ad411 Signed-off-by: Marc Schink <dev@zapb.de> Reviewed-on: http://openocd.zylin.com/6389 Tested-by: jenkins Reviewed-by: Antonio Borneo <borneo.antonio@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/openocd.texi14
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/openocd.texi b/doc/openocd.texi
index c3963d6..0d7719d 100644
--- a/doc/openocd.texi
+++ b/doc/openocd.texi
@@ -2694,14 +2694,14 @@ instead of directly driving JTAG.
The remote_bitbang driver is useful for debugging software running on
processors which are being simulated.
-@deffn {Config Command} {remote_bitbang_port} number
+@deffn {Config Command} {remote_bitbang port} number
Specifies the TCP port of the remote process to connect to or 0 to use UNIX
sockets instead of TCP.
@end deffn
-@deffn {Config Command} {remote_bitbang_host} hostname
+@deffn {Config Command} {remote_bitbang host} hostname
Specifies the hostname of the remote process to connect to using TCP, or the
-name of the UNIX socket to use if remote_bitbang_port is 0.
+name of the UNIX socket to use if remote_bitbang port is 0.
@end deffn
For example, to connect remotely via TCP to the host foobar you might have
@@ -2709,8 +2709,8 @@ something like:
@example
adapter driver remote_bitbang
-remote_bitbang_port 3335
-remote_bitbang_host foobar
+remote_bitbang port 3335
+remote_bitbang host foobar
@end example
To connect to another process running locally via UNIX sockets with socket
@@ -2718,8 +2718,8 @@ named mysocket:
@example
adapter driver remote_bitbang
-remote_bitbang_port 0
-remote_bitbang_host mysocket
+remote_bitbang port 0
+remote_bitbang host mysocket
@end example
@end deffn