From: Marc Schink Date: Tue, 7 May 2019 11:20:30 +0000 (+0200) Subject: Fix 'adapter usb location' documentation X-Git-Tag: v0.11.0-rc1~663 X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=commitdiff_plain;h=e162200ab2cd6c2202bd437dca91137eacf9021c Fix 'adapter usb location' documentation Change-Id: Ifd1d21f2a3cc25ee25e3c7dd04dbb8190d41a1ea Signed-off-by: Marc Schink Reviewed-on: http://openocd.zylin.com/5156 Tested-by: jenkins Reviewed-by: Oleksij Rempel Reviewed-by: Tomas Vanek --- diff --git a/doc/openocd.texi b/doc/openocd.texi index 4fb7b00b16..535fe3a80a 100644 --- a/doc/openocd.texi +++ b/doc/openocd.texi @@ -2370,8 +2370,8 @@ Returns the name of the debug adapter driver being used. @end deffn @anchor{adapter_usb_location} -@deffn Command {adapter usb location} -[.]... -Specifies the physical USB port of the adapter to use. The path +@deffn Command {adapter usb location} [-[.]...] +Displays or specifies the physical USB port of the adapter to use. The path roots at @var{bus} and walks down the physical ports, with each @var{port} option specifying a deeper level in the bus topology, the last @var{port} denoting where the target adapter is actually plugged. diff --git a/src/jtag/adapter.c b/src/jtag/adapter.c index 0a887ef20d..e11f4e9067 100644 --- a/src/jtag/adapter.c +++ b/src/jtag/adapter.c @@ -476,8 +476,8 @@ static const struct command_registration adapter_usb_command_handlers[] = { .name = "location", .handler = &handle_usb_location_command, .mode = COMMAND_CONFIG, - .help = "set the USB bus location of the USB device", - .usage = "-port[.port]...", + .help = "display or set the USB bus location of the USB device", + .usage = "[-port[.port]...]", }, #endif /* HAVE_LIBUSB_GET_PORT_NUMBERS */ COMMAND_REGISTRATION_DONE