From 6d0f8100c1a3053c967bec716e34b65dd054cc39 Mon Sep 17 00:00:00 2001 From: John Darrington Date: Sat, 13 Oct 2018 16:48:01 +0200 Subject: [PATCH] GDB: Document the unix::/path/to/socket of remote connection. gdb/doc: * gdb.texinfo (Connecting)[Remote Connection Commands]: Provide alternative unix::/tmp/xxx example. Include @code{unix::@var{local-socket}} in the list of remote and extended-remote syntaxes. --- gdb/doc/gdb.texinfo | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo index eb00eaa81ae..9616d3795ad 100644 --- a/gdb/doc/gdb.texinfo +++ b/gdb/doc/gdb.texinfo @@ -20829,6 +20829,15 @@ Note that this command has the same form as the command to connect to a serial line. @value{GDBN} will automatically determine which kind of file you have specified and will make the appropriate kind of connection. +The above command is identical to the command: + +@smallexample +target remote unix::/tmp/gdb-socket1 +@end smallexample +@noindent + +See below for the explanation of this syntax. + This feature is not available if the host system does not support Unix domain sockets. @@ -20839,6 +20848,7 @@ Unix domain sockets. @itemx target remote @code{tcp4:@var{host}:@var{port}} @itemx target remote @code{tcp6:@var{host}:@var{port}} @itemx target remote @code{tcp6:@var{[host]}:@var{port}} +@itemx target remote @code{unix::@var{local-socket}} @itemx target extended-remote @code{@var{host}:@var{port}} @itemx target extended-remote @code{@var{[host]}:@var{port}} @itemx target extended-remote @code{tcp:@var{host}:@var{port}} @@ -20846,8 +20856,10 @@ Unix domain sockets. @itemx target extended-remote @code{tcp4:@var{host}:@var{port}} @itemx target extended-remote @code{tcp6:@var{host}:@var{port}} @itemx target extended-remote @code{tcp6:@var{[host]}:@var{port}} +@itemx target extended-remote @code{unix::@var{local-socket}} @cindex @acronym{TCP} port, @code{target remote} -Debug using a @acronym{TCP} connection to @var{port} on @var{host}. +Debug using a @acronym{TCP} connection to @var{port} on @var{host} +or using the Unix domain socket @var{local-socket} on the local machine. The @var{host} may be either a host name, a numeric @acronym{IPv4} address, or a numeric @acronym{IPv6} address (with or without the square brackets to separate the address from the port); @var{port} @@ -20895,6 +20907,16 @@ target remote :1234 @noindent Note that the colon is still required here. +Alternatively you can use a Unix domain socket: + +@smallexample +target remote unix::/tmp/gdb-socket1 +@end smallexample +@noindent + +This has the advantage that it'll not fail if the port number is already +in use. + @item target remote @code{udp:@var{host}:@var{port}} @itemx target remote @code{udp:@var{[host]}:@var{port}} -- 2.30.2