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/introduction.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/introduction.html')
| -rw-r--r-- | docs/introduction.html | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/introduction.html b/docs/introduction.html index 51443a0..bc0d535 100644 --- a/docs/introduction.html +++ b/docs/introduction.html | |||
| @@ -304,7 +304,10 @@ io.write(assert(udp:receive())) | |||
| 304 | <p> Although not covered in the introduction, LuaSocket offers | 304 | <p> Although not covered in the introduction, LuaSocket offers |
| 305 | much more than TCP and UDP functionality. As the library | 305 | much more than TCP and UDP functionality. As the library |
| 306 | evolved, support for <a href=http.html>HTTP</a>, <a href=ftp.html>FTP</a>, | 306 | evolved, support for <a href=http.html>HTTP</a>, <a href=ftp.html>FTP</a>, |
| 307 | and <a href=smtp.html>SMTP</a> were built on top of these. These modules | 307 | and <a href=smtp.html>SMTP</a> were built on top of these. On Unix-like |
| 308 | platforms, the library also ships separate <a href=unix.html>Unix domain | ||
| 309 | socket</a> and <a href=serial.html>serial port</a> modules, requirable as | ||
| 310 | <tt>socket.unix</tt> and <tt>socket.serial</tt>. These modules | ||
| 308 | and many others are covered by the <a href=reference.html>reference manual</a>. | 311 | and many others are covered by the <a href=reference.html>reference manual</a>. |
| 309 | </p> | 312 | </p> |
| 310 | 313 | ||
