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/http.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/http.html | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/docs/http.html b/docs/http.html index c6423ba..316cd2e 100644 --- a/docs/http.html +++ b/docs/http.html | |||
| @@ -114,7 +114,11 @@ the HTTP module: | |||
| 114 | <ul> | 114 | <ul> |
| 115 | <li> <tt>PROXY</tt>: default proxy used for connections;</li> | 115 | <li> <tt>PROXY</tt>: default proxy used for connections;</li> |
| 116 | <li> <tt>TIMEOUT</tt>: sets the timeout for all I/O operations;</li> | 116 | <li> <tt>TIMEOUT</tt>: sets the timeout for all I/O operations;</li> |
| 117 | <li> <tt>USERAGENT</tt>: default user agent reported to server.</li> | 117 | <li> <tt>USERAGENT</tt>: default user agent reported to server;</li> |
| 118 | <li> <tt>MAXHEADERLINE</tt>: maximum length, in bytes, of a single response | ||
| 119 | header line. Defaults to 8192;</li> | ||
| 120 | <li> <tt>MAXHEADERSIZE</tt>: maximum total size, in bytes, of all response | ||
| 121 | header lines combined. Defaults to 65536.</li> | ||
| 118 | </ul> | 122 | </ul> |
| 119 | 123 | ||
| 120 | <p class="note"> | 124 | <p class="note"> |
| @@ -183,7 +187,8 @@ pump step function used to move data. | |||
| 183 | Defaults to the LTN12 <tt>pump.step</tt> function.</li> | 187 | Defaults to the LTN12 <tt>pump.step</tt> function.</li> |
| 184 | <li><tt>proxy</tt>: The URL of a proxy server to use. Defaults to no proxy;</li> | 188 | <li><tt>proxy</tt>: The URL of a proxy server to use. Defaults to no proxy;</li> |
| 185 | <li><tt>redirect</tt>: Set to <tt><b>false</b></tt> to prevent the | 189 | <li><tt>redirect</tt>: Set to <tt><b>false</b></tt> to prevent the |
| 186 | function from automatically following 301 or 302 server redirect messages;</li> | 190 | function from automatically following 301, 302, 303, 307 or 308 server |
| 191 | redirect messages;</li> | ||
| 187 | <li><tt>create</tt>: An optional function to be used instead of | 192 | <li><tt>create</tt>: An optional function to be used instead of |
| 188 | <a href="tcp.html#socket.tcp"><tt>socket.tcp</tt></a> when the communications socket is created.</li> | 193 | <a href="tcp.html#socket.tcp"><tt>socket.tcp</tt></a> when the communications socket is created.</li> |
| 189 | <li><tt>maxredirects</tt>: An optional number specifying the maximum number of | 194 | <li><tt>maxredirects</tt>: An optional number specifying the maximum number of |
