hare

commit ee65ab8e4c883c610adfec3aa494553f2d807705
parent 4266189fdd1579928e3565f3281f697ad5827c0f
Author: Drew DeVault <sir@cmpwn.com>
Date:   Mon, 21 Jun 2021 14:29:35 -0400

net::dial: update docs per generalized design

Signed-off-by: Drew DeVault <sir@cmpwn.com>

Diffstat:
M
net/dial/dial.ha
 | 
10
++++++----

1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/net/dial/dial.ha b/net/dial/dial.ha
@@ -7,10 +7,12 @@ use net;
 // and the service should be the name of the service, or the default port to
 // use.
 //
-// The address parameter may be either an IPv4 or IPv6 address, or a name, and
-// may include a port separated by a colon (':'). If an IPv6 address and a port
-// are both desired, use brackets ('[' and ']') to separate the address from the
-// port (e.g. "[::1]:80"). If the port is not specified, it is inferred from the
+// The interpretation of the address and service parameters is dependent on the
+// protocol in use. For IP-based protocols (such as TCP or UDP), the address
+// parameter may be either an IPv4 or IPv6 address, or a name, and may include a
+// port separated by a colon (':'). If an IPv6 address and a port are both
+// desired, use brackets ('[' and ']') to separate the address from the port
+// (e.g. "[::1]:80"). If the port is not specified, it is inferred from the
 // service parameter. If a name is used instead of an IP address, a DNS lookup
 // is performed, consulting the local /etc/hosts file or equivalent, if
 // possible.