From d02984bbb773470bd28238db5721765d20dcf4ce Mon Sep 17 00:00:00 2001 From: Martin Pool Date: Thu, 24 Jan 2002 04:19:41 +0000 Subject: [PATCH] Doc. --- socket.c | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/socket.c b/socket.c index eb1ab3f5..8f8d96dd 100644 --- a/socket.c +++ b/socket.c @@ -817,13 +817,16 @@ static int socketpair_tcp(int fd[2]) } -/******************************************************************* -run a program on a local tcp socket, this is used to launch smbd -when regression testing -the return value is a socket which is attached to a subprocess -running "prog". stdin and stdout are attached. stderr is left -attached to the original stderr - ******************************************************************/ + +/** + * Run a program on a local tcp socket, so that we can talk to it's + * stdin and stdout. This is used to launch ssh and similar + * connection helper programs for rsync. + * + * @return a socket which is attached to a subprocess running + * "prog". stdin and stdout are attached. stderr is left attached to + * the original stderr + **/ int sock_exec(const char *prog) { int fd[2]; -- 2.34.1