diff options
author | Jo-Philipp Wich <jo@mein.io> | 2018-03-12 15:59:52 +0100 |
---|---|---|
committer | Jo-Philipp Wich <jo@mein.io> | 2018-03-12 16:02:27 +0100 |
commit | 190b32452acd969f7264e990d139aae78dca67d0 (patch) | |
tree | 888b873e9c9fbc9fabd6b1c5c3d8ce07c2ef0105 /documentation | |
parent | 62630fbf880058aa1c7ae10ecf5ae5cb6e4af5bb (diff) |
luci-lib-nixio: fix spelling mistakes in documentation
Signed-off-by: Jo-Philipp Wich <jo@mein.io>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/api/modules/nixio.README.html | 6 | ||||
-rw-r--r-- | documentation/api/modules/nixio.UnifiedIO.html | 10 |
2 files changed, 8 insertions, 8 deletions
diff --git a/documentation/api/modules/nixio.README.html b/documentation/api/modules/nixio.README.html index d8a17f78b4..99e036b828 100644 --- a/documentation/api/modules/nixio.README.html +++ b/documentation/api/modules/nixio.README.html @@ -288,7 +288,7 @@ <br />In general all functions are namend and behave like their POSIX API counterparts - where applicable - applying the following rules: <ul> - <li>Functions should be named like the underlying POSIX API function omitting + <li>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, ...)</li> <li>If you are unclear about the behaviour of a function you should consult @@ -296,10 +296,10 @@ <li>If the name is significantly different from the POSIX-function, the underlying function(s) are stated in the documentation.</li> <li>Parameters should reflect those of the C-API, buffer length arguments and - by-reference parameters should be omitted for pratical purposes.</li> + by-reference parameters should be omitted for practical purposes.</li> <li>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 omitting 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.) </li> diff --git a/documentation/api/modules/nixio.UnifiedIO.html b/documentation/api/modules/nixio.UnifiedIO.html index 1717980841..700485dbe4 100644 --- a/documentation/api/modules/nixio.UnifiedIO.html +++ b/documentation/api/modules/nixio.UnifiedIO.html @@ -326,7 +326,7 @@ <li>The blocksize given is only advisory and to be seen as an upper limit, if an underlying read returns less bytes the chunk is nevertheless returned. - <li>If the limit parameter is omitted, the iterator returns data + <li>If the limit parameter is omitted, the iterator returns data until an end-of-file, end-of-stream, connection shutdown or similar happens. <li>The iterator will not buffer so it is safe to mix with calls to read. @@ -402,7 +402,7 @@ true <li>This function uses the blocksource function of the source descriptor and the sink function of the target descriptor. - <li>If the limit parameter is omitted, data is copied + <li>If the limit parameter is omitted, data is copied until an end-of-file, end-of-stream, connection shutdown or similar happens. <li>If the descriptor is non-blocking the function may fail with EAGAIN. @@ -461,7 +461,7 @@ true blocksource function of the source descriptor and the sink function of the target descriptor as a fallback mechanism. - <li>If the limit parameter is omitted, data is copied + <li>If the limit parameter is omitted, data is copied until an end-of-file, end-of-stream, connection shutdown or similar happens. <li>If the descriptor is non-blocking the function may fail with EAGAIN. @@ -584,7 +584,7 @@ boolean you can pass "true" to the iterator which will flush the buffer and return the bufferd data. - <li>If the limit parameter is omitted, this function uses the nixio + <li>If the limit parameter is omitted, this function uses the nixio buffersize (8192B by default). <li>If the descriptor is non-blocking the iterator may fail with EAGAIN. @@ -628,7 +628,7 @@ Line-based Iterator <li>This function uses the low-level read function of the descriptor. - <li>If the length parameter is omitted, this function returns all data + <li>If the length parameter is omitted, this function returns all data that can be read before an end-of-file, end-of-stream, connection shutdown or similar happens. |