From 70f7800986812ad0d1a5dd6f280f66fd2bf1dd12 Mon Sep 17 00:00:00 2001 From: Thijs Schreijer Date: Tue, 1 Sep 2026 10:00:21 +0200 Subject: docs: document socket.unix and socket.serial, fix stale/missing API references 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. --- docs/installation.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/installation.html') diff --git a/docs/installation.html b/docs/installation.html index b56f50f..bdc8b1d 100644 --- a/docs/installation.html +++ b/docs/installation.html @@ -57,7 +57,7 @@ luarocks install luasocket print(socket._VERSION) -

If you see output like LuaSocket 3.0, the installation was successful.

+

If you see output like LuaSocket 3.1.0, the installation was successful.

More Information

For more details, visit the LuaSocket GitHub repository.

-- cgit v1.2.3-55-g6feb