luasocket/docs/socket.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.
feat(headers): dynamically create cononicalized headers2026-08-29T17:43:26+00:00Thijs Schreijerthijs@thijsschreijer.nl2026-08-29T17:39:35+00:00urn:sha1:a63fa963b7bd01f1b470bea7c5a2ed326ff760e6
Instead of a static list dynamically add entries in proper casing.
Also allowing to add non-standard ones through `setcanonic`.
closes #442
fixes #440
chore(docs): update LTN12 links (#428)2024-03-15T11:55:02+00:00Thijs Schreijerthijs@thijsschreijer.nl2024-03-15T11:55:02+00:00urn:sha1:93eef5015e0dfe8d24071dd036f9a7f02160abebfix(docs): link to included LTN documents (#426)2024-03-05T20:18:24+00:00Thijs Schreijerthijs@thijsschreijer.nl2024-03-05T20:18:24+00:00urn:sha1:23241717bf91c4317065828bedafd05ebb97c1efMove 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