From: Jens Axboe <axboe@kernel.dk>
Date: Mon, 24 Oct 2011 07:35:06 +0000 (+0200)
Subject: server: document fio_server_parse_string()
X-Git-Tag: fio-1.99.10~5
X-Git-Url: https://git.kernel.dk/?a=commitdiff_plain;h=660a2bfb0858f94633f9e567b81968981541f079;p=fio.git

server: document fio_server_parse_string()

Signed-off-by: Jens Axboe <axboe@kernel.dk>
---

diff --git a/server.c b/server.c
index 6a5bc6ce..81ec6b0e 100644
--- a/server.c
+++ b/server.c
@@ -943,6 +943,18 @@ static int fio_init_server_connection(void)
 	return sk;
 }
 
+/*
+ * Parse a host/ip/port string. Reads from 'str'.
+ *
+ * Outputs:
+ *
+ * For IPv4:
+ *	*ptr is the host, *port is the port, inp is the destination.
+ * For IPv6:
+ *	*ptr is the host, *port is the port, inp6 is the dest, and *ipv6 is 1.
+ * For local domain sockets:
+ *	*ptr is the filename, *is_sock is 1.
+ */
 int fio_server_parse_string(const char *str, char **ptr, int *is_sock,
 			    int *port, struct in_addr *inp,
 			    struct in6_addr *inp6, int *ipv6)