X-Git-Url: http://git.archive.openwrt.org/?p=project%2Fluci.git;a=blobdiff_plain;f=libs%2Fluci-lib-nixio%2Fdocsrc%2FREADME.lua;h=9860cf0919595f365d346d38c90b9cecd8f330d6;hp=ee3e3a216c06d302d76d00883dd40779d3a37423;hb=190b32452acd969f7264e990d139aae78dca67d0;hpb=62630fbf880058aa1c7ae10ecf5ae5cb6e4af5bb;ds=sidebyside
diff --git a/libs/luci-lib-nixio/docsrc/README.lua b/libs/luci-lib-nixio/docsrc/README.lua
index ee3e3a216..9860cf091 100644
--- a/libs/luci-lib-nixio/docsrc/README.lua
+++ b/libs/luci-lib-nixio/docsrc/README.lua
@@ -33,7 +33,7 @@ module "nixio.README"
--
In general all functions are namend and behave like their POSIX API
-- counterparts - where applicable - applying the following rules:
--
--- - Functions should be named like the underlying POSIX API function ommiting
+--
- Functions should be named like the underlying POSIX API function omitting
-- prefixes or suffixes - especially when placed in an object-context (
-- lockf -> File:lock, fsync -> File:sync, dup2 -> dup, ...)
-- - If you are unclear about the behaviour of a function you should consult
@@ -41,10 +41,10 @@ module "nixio.README"
--
- If the name is significantly different from the POSIX-function, the
-- underlying function(s) are stated in the documentation.
-- - Parameters should reflect those of the C-API, buffer length arguments and
--- by-reference parameters should be ommitted for pratical purposes.
+-- by-reference parameters should be omitted for practical purposes.
-- - If a C function accepts a bitfield as parameter, it should be translated
-- into lower case string flags representing the flags if the bitfield is the
--- last parameter and also ommiting prefixes or suffixes. (e.g. waitpid
+-- last parameter and also omitting prefixes or suffixes. (e.g. waitpid
-- (pid, &s, WNOHANG | WUNTRACED) -> waitpid(pid, "nohang", "untraced"),
-- getsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt)) ->
-- Socket:getopt("socket", "reuseaddr"), etc.)