zyppe/luasocket
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

First stab at documenation

Browse source 
Update Lua and Luasocket version in samples and in documentation
Documented ipv5_v6only default option being set
Documented tcp6 and udp6
Documented dns.getaddrinfo
Documented zero-sized datagram change?
Documented getoption
This commit is contained in:
Diego Nehab 2012-04-17 01:15:26 +08:00
parent b3c4f46179
commit f37e026026
12 changed files with 367 additions and 197 deletions
Download patch file Download diff file Expand all files Collapse all files

79
TODO
View file

@ -1,38 +1,47 @@
- merge luaL_typeerror into auxiliar to avoid using luaL prefix?
- document ipv5_v6only default option being set?
- document bind and connect behavior based on address?
- document tcp6 and udp6
- document dns.getaddrinfo
- check getaddrinfo's output format
- add functionality to query if object is ipv4 or 6?
- normalize error messages to have all first capitals or not?
- what is this lua_Reg vs lua_reg business?
what is this putchar vs addchar business?
is this the compat-5.2 stuff?
- why 2.1.1 rather than 2.1?
- update copyright date everywhere?
- what to do about author?
- any chance we can do without the compat for the final release?
- are only _API symbols being exported now?
it used to export all externs...
- document zero-sized send on udp vs. tcp?
- add http POST sample to manual
people keep asking stupid questions
- document unix socket and serial socket? add raw support?
if so, add tests?
- make sure unix conforms to tcp and udp style
- make sure serial conforms to tcp and udp style
does it need to use write/read instead of send/receive?
- documentation of dirty/getfd/setfd is problematic because of portability
same for unix and serial.
what to do about this? add a stronger disclaimer?
- nice getoption!
prefix all setters with set_ and all getters with get_?
- add what's new to manual
- remove references to Lua 5.0 from documentation, add 5.2?
- update lua and luasocket version in samples in documentation
- document headers.lua?
- fix makefile with decent defaults?
- merge luaL_typeerror into auxiliar to avoid using luaL prefix?
- getsockname should also support IPv6, no?
- remove RCSID from files?
- shouldn't we instead make the code compatible to Lua 5.2
without any compat stuff, and use a compatibility layer to
make it work on 5.1?
- why 2.1.1 rather than 2.1?
- add what's new to manual
- should there be an equivalent to tohostname for IPv6?
- should we add service name resolution as well to
getaddrinfo?
- document bind and connect behavior based on address?
- add functionality to query if object is ipv4 or 6?
- update copyright date everywhere?
- what to do about author?
- add http POST sample to manual
people keep asking stupid questions
- documentation of dirty/getfd/setfd is problematic because of portability
same for unix and serial.
what to do about this? add a stronger disclaimer?
- remove references to Lua 5.0 from documentation, add 5.2?
- update lua and luasocket version in samples in documentation
- document headers.lua?
- fix makefile with decent defaults?
Done:
- document ipv5_v6only default option being set?
- document tcp6 and udp6
- document dns.getaddrinfo
- document zero-sized send on udp vs. tcp?
no.
- document unix socket and serial socket? add raw support?
no.
- document getoption
replace \r\n with \0xD\0xA in everything