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/index.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 '')
| -rw-r--r-- | docs/index.html | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/index.html b/docs/index.html index 3341f8d..7a22dd6 100644 --- a/docs/index.html +++ b/docs/index.html | |||
| @@ -67,6 +67,8 @@ In addition, you will find that the | |||
| 67 | (anything you could possible want to do with one) and | 67 | (anything you could possible want to do with one) and |
| 68 | <a href="ltn12.html">LTN12</a> | 68 | <a href="ltn12.html">LTN12</a> |
| 69 | (filters, sinks, sources and pumps) modules can be very handy. | 69 | (filters, sinks, sources and pumps) modules can be very handy. |
| 70 | On Unix-like platforms, dedicated <a href="unix.html">Unix domain socket</a> | ||
| 71 | and <a href="serial.html">serial port</a> modules are also available. | ||
| 70 | </p> | 72 | </p> |
| 71 | 73 | ||
| 72 | <p> | 74 | <p> |
