diff options
| author | Thijs Schreijer <thijs@thijsschreijer.nl> | 2026-09-01 10:00:21 +0200 |
|---|---|---|
| committer | Thijs Schreijer <thijs@thijsschreijer.nl> | 2026-09-01 10:48:40 +0200 |
| commit | 70f7800986812ad0d1a5dd6f280f66fd2bf1dd12 (patch) | |
| tree | 36051874b3ce036307d4bb69b3c4058458b6255d /docs/dns.html | |
| parent | fa9b35a0cf11bc856cbd8bffbef5ad6fb3e62a93 (diff) | |
| download | luasocket-docs/pre-release-audit.tar.gz luasocket-docs/pre-release-audit.tar.bz2 luasocket-docs/pre-release-audit.zip | |
docs: document socket.unix and socket.serial, fix stale/missing API referencesdocs/pre-release-audit
Pre-release documentation audit against master. Adds the two fully
undocumented modules and closes gaps found by diffing every docs/*.html
page against its corresponding source:
- New docs/unix.html and docs/serial.html (socket.unix stream/dgram and
socket.serial were never documented), linked from index.html,
introduction.html, socket.html and reference.html. serial.html notes
the current lack of a baud/parity/flow-control API and includes an
os.execute+stty workaround example. Both note Windows is unsupported.
- socket.html: document headers.setcanonic, point to unix/serial modules.
- tcp.html: document getfamily, setpeername/setsockname aliases.
- udp.html: document getfamily, getfd/setfd, dirty; document the
ipv6-multicast-hops/ipv6-unicast-hops aliasing as current (known-buggy)
behavior rather than the originally intended semantics.
- http.html: correct redirect text (301/302/303/307/308, was 301/302
only); document MAXHEADERLINE/MAXHEADERSIZE.
- dns.html: document getnameinfo.
- ltn12.html: document source.rewind and BLOCKSIZE.
- installation.html: fix stale "LuaSocket 3.0" sample output to 3.1.0.
- reference.html: index every anchor added above plus new Unix/Serial
blocks.
Diffstat (limited to 'docs/dns.html')
| -rw-r--r-- | docs/dns.html | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/dns.html b/docs/dns.html index 56ce3ba..e8320e8 100644 --- a/docs/dns.html +++ b/docs/dns.html | |||
| @@ -106,6 +106,32 @@ the resolver. In case of error, the function returns <b><tt>nil</tt></b> | |||
| 106 | followed by an error message. | 106 | followed by an error message. |
| 107 | </p> | 107 | </p> |
| 108 | 108 | ||
| 109 | <!-- getnameinfo ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | ||
| 110 | |||
| 111 | <p class="name" id="getnameinfo"> | ||
| 112 | socket.dns.<b>getnameinfo(</b>[host] [, service]<b>)</b> | ||
| 113 | </p> | ||
| 114 | |||
| 115 | <p class="description"> | ||
| 116 | Resolves a host and/or a service name through the system resolver and | ||
| 117 | returns their canonical name form. At least one of <tt>host</tt> or | ||
| 118 | <tt>service</tt> must be given. | ||
| 119 | </p> | ||
| 120 | |||
| 121 | <p class="parameters"> | ||
| 122 | <tt>Host</tt> is an optional string with a host name or IP address. | ||
| 123 | <tt>Service</tt> is an optional string with a service name or port number. | ||
| 124 | </p> | ||
| 125 | |||
| 126 | <p class="return"> | ||
| 127 | If <tt>host</tt> was given, returns a numerically-indexed table with the | ||
| 128 | canonical host name found for each address the resolver returns for | ||
| 129 | <tt>host</tt>. If <tt>service</tt> was also given, the canonical service | ||
| 130 | name is returned as an additional value; if only <tt>service</tt> was | ||
| 131 | given, its canonical name is returned by itself. In case of error, the | ||
| 132 | function returns <b><tt>nil</tt></b> followed by an error message. | ||
| 133 | </p> | ||
| 134 | |||
| 109 | <!-- gethostname ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | 135 | <!-- gethostname ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> |
| 110 | 136 | ||
| 111 | <p class="name" id="gethostname"> | 137 | <p class="name" id="gethostname"> |
