luasocket/docs/index.html, branch docs/pre-release-auditA mirror of https://github.com/lunarmodules/luasocket.git
https://git.lua4.win/luasocket/atom?h=docs%2Fpre-release-audit2026-09-01T08:48:40+00:00docs: document socket.unix and socket.serial, fix stale/missing API references2026-09-01T08:48:40+00:00Thijs Schreijerthijs@thijsschreijer.nl2026-09-01T08:00:21+00:00urn:sha1:70f7800986812ad0d1a5dd6f280f66fd2bf1dd12
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.
Add Lua 5.5 support (#473)2026-08-31T15:21:20+00:00Caleb Maclennancaleb@alerque.com2026-08-31T15:21:20+00:00urn:sha1:fa9b35a0cf11bc856cbd8bffbef5ad6fb3e62a93chore: Release v3.1.02022-07-27T07:07:00+00:00Caleb Maclennancaleb@alerque.com2022-07-27T07:06:54+00:00urn:sha1:95b7efa9da506ef968c1347edf3fc56370f0deedchore: Release v3.0.02022-03-25T08:05:48+00:00Caleb Maclennancaleb@alerque.com2022-03-25T06:56:50+00:00urn:sha1:88c8a85cb6528232288ec590910b7a966aace52bdocs: Drop obsolete changelog from docs index2022-03-25T07:59:23+00:00Caleb Maclennancaleb@alerque.com2022-03-25T07:09:13+00:00urn:sha1:f7f0a77a3dbcd066c2f228ada63ee78546a01f78Update URL references to source repository2022-03-22T21:16:23+00:00Caleb Maclennancaleb@alerque.com2022-03-22T21:16:23+00:00urn:sha1:2eac8950396247b412c4089c23a46015c8cc12bbMove doc→docs so we can serve it with GitHub Pages2022-03-22T21:11:24+00:00Caleb Maclennancaleb@alerque.com2022-03-22T21:09:53+00:00urn:sha1:f98977b2dac48fc66822402b095336e683715126