nixio: Update documentation to prepare 0.3 release
This commit is contained in:
parent
21be73a478
commit
72a0ee36b6
4 changed files with 35 additions and 11 deletions
29
libs/nixio/docsrc/CHANGELOG.lua
Normal file
29
libs/nixio/docsrc/CHANGELOG.lua
Normal file
|
@ -0,0 +1,29 @@
|
|||
--- Changes and improvements.
|
||||
module "CHANGELOG"
|
||||
|
||||
--- Nixio 0.3
|
||||
-- <ul>
|
||||
-- <li>Added getifaddrs() function.</li>
|
||||
-- <li>Added getsockopt(), setsockopt(), getsockname() and getpeername()
|
||||
-- directly to TLS-socket objects unifying the socket interface.</li>
|
||||
-- <li>Added support for CyaSSL as cryptographical backend.</li>
|
||||
-- <li>Added support for x509 certificates in DER format.</li>
|
||||
-- <li>Added support for splice() in UnifiedIO.copyz().</li>
|
||||
-- <li>Added interface to inject chunks into UnifiedIO.linesource() buffer.</li>
|
||||
-- <li>Changed TLS behaviour to explicitely separate servers and clients.</li>
|
||||
-- <li>Fixed usage of signed datatype breaking Base64 decoding.</li>
|
||||
-- <li>Fixed namespace clashes for nixio.fs.</li>
|
||||
-- <li>Fixed splice() support for some exotic C libraries.</li>
|
||||
-- <li>Reconfigure axTLS cryptographical provider.</li>
|
||||
-- </ul>
|
||||
-- @class table
|
||||
-- @name 0.2
|
||||
-- @return !
|
||||
|
||||
--- Nixio 0.2
|
||||
-- <ul>
|
||||
-- <li>Initial Release</li>
|
||||
-- </ul>
|
||||
-- @class table
|
||||
-- @name 0.2
|
||||
-- @return !
|
|
@ -80,15 +80,12 @@ module "README"
|
|||
|
||||
--- Cryptography and TLS libraries.
|
||||
-- <ul>
|
||||
-- <li>Currently 2 underlying cryptography libraries are supported: openssl and
|
||||
-- axTLS. The name of the library in use is written to
|
||||
-- <li>Currently 3 underlying cryptography libraries are supported: openssl,
|
||||
-- cyassl and axTLS. The name of the library in use is written to
|
||||
-- <strong>nixio.tls_provider</strong></li>
|
||||
-- <li>You should whenever possible use openssl as axTLS has only limited
|
||||
-- support. It does not provide support for non-blocking sockets and
|
||||
-- is probably less audited than openssl.</li>
|
||||
-- <li>However in embedded development if you don't need openssl anyway
|
||||
-- you may safe an essential amount of flash space (about 1 MB for the openssl
|
||||
-- library) by choosing axTLS over openssl.</li>
|
||||
-- <li>You should whenever possible use openssl or cyassl as axTLS has only
|
||||
-- limited support. It does not provide support for non-blocking sockets and
|
||||
-- is probably less audited than the other ones.</li>
|
||||
-- <li>As the supported Windows versions are not suitable for embedded devices
|
||||
-- axTLS is at the moment not supported on Windows.</li>
|
||||
-- </ul>
|
||||
|
|
|
@ -111,7 +111,6 @@ module "nixio.UnifiedIO"
|
|||
-- @usage This function uses the sendfile() syscall to copy the data or the
|
||||
-- blocksource function of the source descriptor and the sink function
|
||||
-- of the target descriptor as a fallback mechanism.
|
||||
-- @usage Support for splice() on Linux is not implemented yet.
|
||||
-- @usage If the limit parameter is ommited, data is copied
|
||||
-- until an end-of-file, end-of-stream, connection shutdown or similar happens.
|
||||
-- @usage If the descriptor is non-blocking the function may fail with EAGAIN.
|
||||
|
|
|
@ -42,7 +42,6 @@ clean: luaclean
|
|||
|
||||
luasource:
|
||||
mkdir -p dist$(LUA_MODULEDIR)
|
||||
cp -pR root/* dist 2>/dev/null || true
|
||||
cp -pR lua/* dist$(LUA_MODULEDIR) 2>/dev/null || true
|
||||
for i in $$(find dist -name .svn); do rm -rf $$i || true; done
|
||||
|
||||
|
@ -53,4 +52,4 @@ luacompile: luasource
|
|||
for i in $$(find dist -name *.lua -not -name debug.lua); do $(LUAC) $(LUAC_OPTIONS) -o $$i $$i; done
|
||||
|
||||
luaclean:
|
||||
rm -rf dist
|
||||
rm -rf dist
|
||||
|
|
Loading…
Reference in a new issue