docs: added note for increasing gdb remotetimeout when using the "gdb_port pipe"...

Change-Id: I9c9514a193fd65454890571a17373b9c64d84757
Signed-off-by: fenugrec <fenugrec@users.sourceforge.net>
Signed-off-by: Paul Fertser <fercerpav@gmail.com>
Reviewed-on: http://openocd.zylin.com/3040
Tested-by: jenkins
Reviewed-by: Freddie Chopin <freddie.chopin@gmail.com>

diff --git a/doc/openocd.texi b/doc/openocd.texi
index 63bbf21026b402d8f0db1a38581d62877e741c0d..0608a28d231060c8b04dc45c8b7361cb6d4bf8cd 100644 (file)
--- a/doc/openocd.texi
+++ b/doc/openocd.texi
@@ -2126,6 +2126,11 @@ The GDB port for the first target will be the base 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.
+
+Note: when using "gdb_port pipe", increasing the default remote timeout in
+gdb (with 'set remotetimeout') is recommended. An insufficient timeout may
+cause initialization to fail with "Unknown remote qXfer reply: OK".
+
 @end deffn
 
 @deffn {Command} tcl_port [number]