luci-lib-nixio: fix spelling mistakes in documentation
Signed-off-by: Jo-Philipp Wich <jo@mein.io>
This commit is contained in:
parent
62630fbf88
commit
190b32452a
7 changed files with 32 additions and 32 deletions
|
@ -288,7 +288,7 @@
|
||||||
<br />In general all functions are namend and behave like their POSIX API
|
<br />In general all functions are namend and behave like their POSIX API
|
||||||
counterparts - where applicable - applying the following rules:
|
counterparts - where applicable - applying the following rules:
|
||||||
<ul>
|
<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 (
|
prefixes or suffixes - especially when placed in an object-context (
|
||||||
lockf -> File:lock, fsync -> File:sync, dup2 -> dup, ...)</li>
|
lockf -> File:lock, fsync -> File:sync, dup2 -> dup, ...)</li>
|
||||||
<li>If you are unclear about the behaviour of a function you should consult
|
<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
|
<li>If the name is significantly different from the POSIX-function, the
|
||||||
underlying function(s) are stated in the documentation.</li>
|
underlying function(s) are stated in the documentation.</li>
|
||||||
<li>Parameters should reflect those of the C-API, buffer length arguments and
|
<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
|
<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
|
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"),
|
(pid, &s, WNOHANG | WUNTRACED) -> waitpid(pid, "nohang", "untraced"),
|
||||||
getsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt)) ->
|
getsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt)) ->
|
||||||
Socket:getopt("socket", "reuseaddr"), etc.) </li>
|
Socket:getopt("socket", "reuseaddr"), etc.) </li>
|
||||||
|
|
|
@ -326,7 +326,7 @@
|
||||||
<li>The blocksize given is only advisory and to be seen as an upper limit,
|
<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.
|
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.
|
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.
|
<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
|
<li>This function uses the blocksource function of the source descriptor
|
||||||
and the sink function of the target 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.
|
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.
|
<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
|
blocksource function of the source descriptor and the sink function
|
||||||
of the target descriptor as a fallback mechanism.
|
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.
|
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.
|
<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
|
you can pass "true" to the iterator which will flush the buffer
|
||||||
and return the bufferd data.
|
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).
|
buffersize (8192B by default).
|
||||||
|
|
||||||
<li>If the descriptor is non-blocking the iterator may fail with EAGAIN.
|
<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>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
|
that can be read before an end-of-file, end-of-stream, connection shutdown
|
||||||
or similar happens.
|
or similar happens.
|
||||||
|
|
||||||
|
|
|
@ -33,7 +33,7 @@ module "nixio.README"
|
||||||
-- <br />In general all functions are namend and behave like their POSIX API
|
-- <br />In general all functions are namend and behave like their POSIX API
|
||||||
-- counterparts - where applicable - applying the following rules:
|
-- counterparts - where applicable - applying the following rules:
|
||||||
-- <ul>
|
-- <ul>
|
||||||
-- <li>Functions should be named like the underlying POSIX API function ommiting
|
-- <li>Functions should be named like the underlying POSIX API function omitting
|
||||||
-- prefixes or suffixes - especially when placed in an object-context (
|
-- prefixes or suffixes - especially when placed in an object-context (
|
||||||
-- lockf -> File:lock, fsync -> File:sync, dup2 -> dup, ...)</li>
|
-- lockf -> File:lock, fsync -> File:sync, dup2 -> dup, ...)</li>
|
||||||
-- <li>If you are unclear about the behaviour of a function you should consult
|
-- <li>If you are unclear about the behaviour of a function you should consult
|
||||||
|
@ -41,10 +41,10 @@ module "nixio.README"
|
||||||
-- <li>If the name is significantly different from the POSIX-function, the
|
-- <li>If the name is significantly different from the POSIX-function, the
|
||||||
-- underlying function(s) are stated in the documentation.</li>
|
-- underlying function(s) are stated in the documentation.</li>
|
||||||
-- <li>Parameters should reflect those of the C-API, buffer length arguments and
|
-- <li>Parameters should reflect those of the C-API, buffer length arguments and
|
||||||
-- by-reference parameters should be ommitted 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
|
-- <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
|
-- 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"),
|
-- (pid, &s, WNOHANG | WUNTRACED) -> waitpid(pid, "nohang", "untraced"),
|
||||||
-- getsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt)) ->
|
-- getsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt)) ->
|
||||||
-- Socket:getopt("socket", "reuseaddr"), etc.) </li>
|
-- Socket:getopt("socket", "reuseaddr"), etc.) </li>
|
||||||
|
|
|
@ -71,7 +71,7 @@ module "nixio.Socket"
|
||||||
|
|
||||||
--- Send a message on the socket.
|
--- Send a message on the socket.
|
||||||
-- This function is identical to sendto except for the missing destination
|
-- This function is identical to sendto except for the missing destination
|
||||||
-- paramters. See the sendto description for a detailed description.
|
-- parameters. See the sendto description for a detailed description.
|
||||||
-- @class function
|
-- @class function
|
||||||
-- @name Socket.send
|
-- @name Socket.send
|
||||||
-- @param buffer Buffer holding the data to be written.
|
-- @param buffer Buffer holding the data to be written.
|
||||||
|
@ -167,4 +167,4 @@ module "nixio.Socket"
|
||||||
-- "mtu" (IP, IPv6), "hdrincl" (IP), "multicast_ttl" (IP), "multicast_loop"
|
-- "mtu" (IP, IPv6), "hdrincl" (IP), "multicast_ttl" (IP), "multicast_loop"
|
||||||
-- (IP, IPv6), "multicast_if" (IP, IPv6), "v6only" (IPv6), "multicast_hops"
|
-- (IP, IPv6), "multicast_if" (IP, IPv6), "v6only" (IPv6), "multicast_hops"
|
||||||
-- (IPv6), "add_membership" (IP, IPv6), "drop_membership" (IP, IPv6)]
|
-- (IPv6), "add_membership" (IP, IPv6), "drop_membership" (IP, IPv6)]
|
||||||
-- @return Value
|
-- @return Value
|
||||||
|
|
|
@ -24,15 +24,15 @@ module "nixio.UnifiedIO"
|
||||||
-- @class function
|
-- @class function
|
||||||
-- @name UnifiedIO.readall
|
-- @name UnifiedIO.readall
|
||||||
-- @usage This function uses the low-level read function of the descriptor.
|
-- @usage This function uses the low-level read function of the descriptor.
|
||||||
-- @usage If the length parameter is ommited, this function returns all data
|
-- @usage 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
|
-- that can be read before an end-of-file, end-of-stream, connection shutdown
|
||||||
-- or similar happens.
|
-- or similar happens.
|
||||||
-- @usage If the descriptor is non-blocking this function may fail with EAGAIN.
|
-- @usage If the descriptor is non-blocking this function may fail with EAGAIN.
|
||||||
-- @param length Bytes to read (optional)
|
-- @param length Bytes to read (optional)
|
||||||
-- @return data that was successfully read if no error occured
|
-- @return data that was successfully read if no error occurred
|
||||||
-- @return - reserved for error code -
|
-- @return - reserved for error code -
|
||||||
-- @return - reserved for error message -
|
-- @return - reserved for error message -
|
||||||
-- @return data that was successfully read even if an error occured
|
-- @return data that was successfully read even if an error occurred
|
||||||
|
|
||||||
--- Write a block of data and wait until all data is written.
|
--- Write a block of data and wait until all data is written.
|
||||||
-- @class function
|
-- @class function
|
||||||
|
@ -40,10 +40,10 @@ module "nixio.UnifiedIO"
|
||||||
-- @usage This function uses the low-level write function of the descriptor.
|
-- @usage This function uses the low-level write function of the descriptor.
|
||||||
-- @usage If the descriptor is non-blocking this function may fail with EAGAIN.
|
-- @usage If the descriptor is non-blocking this function may fail with EAGAIN.
|
||||||
-- @param block Bytes to write
|
-- @param block Bytes to write
|
||||||
-- @return bytes that were successfully written if no error occured
|
-- @return bytes that were successfully written if no error occurred
|
||||||
-- @return - reserved for error code -
|
-- @return - reserved for error code -
|
||||||
-- @return - reserved for error message -
|
-- @return - reserved for error message -
|
||||||
-- @return bytes that were successfully written even if an error occured
|
-- @return bytes that were successfully written even if an error occurred
|
||||||
|
|
||||||
--- Create a line-based iterator.
|
--- Create a line-based iterator.
|
||||||
-- Lines may end with either \n or \r\n, these control chars are not included
|
-- Lines may end with either \n or \r\n, these control chars are not included
|
||||||
|
@ -56,7 +56,7 @@ module "nixio.UnifiedIO"
|
||||||
-- to stop reading line-based and want to use the read(all) functions instead
|
-- to stop reading line-based and want to use the read(all) functions instead
|
||||||
-- you can pass "true" to the iterator which will flush the buffer
|
-- you can pass "true" to the iterator which will flush the buffer
|
||||||
-- and return the bufferd data.
|
-- and return the bufferd data.
|
||||||
-- @usage If the limit parameter is ommited, this function uses the nixio
|
-- @usage If the limit parameter is omitted, this function uses the nixio
|
||||||
-- buffersize (8192B by default).
|
-- buffersize (8192B by default).
|
||||||
-- @usage If the descriptor is non-blocking the iterator may fail with EAGAIN.
|
-- @usage If the descriptor is non-blocking the iterator may fail with EAGAIN.
|
||||||
-- @usage The iterator can be used as an LTN12 source.
|
-- @usage The iterator can be used as an LTN12 source.
|
||||||
|
@ -69,7 +69,7 @@ module "nixio.UnifiedIO"
|
||||||
-- @usage This function uses the low-level read function of the descriptor.
|
-- @usage This function uses the low-level read function of the descriptor.
|
||||||
-- @usage The blocksize given is only advisory and to be seen as an upper limit,
|
-- @usage 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.
|
-- if an underlying read returns less bytes the chunk is nevertheless returned.
|
||||||
-- @usage If the limit parameter is ommited, the iterator returns data
|
-- @usage If the limit parameter is omitted, the iterator returns data
|
||||||
-- until an end-of-file, end-of-stream, connection shutdown or similar happens.
|
-- until an end-of-file, end-of-stream, connection shutdown or similar happens.
|
||||||
-- @usage The iterator will not buffer so it is safe to mix with calls to read.
|
-- @usage The iterator will not buffer so it is safe to mix with calls to read.
|
||||||
-- @usage If the descriptor is non-blocking the iterator may fail with EAGAIN.
|
-- @usage If the descriptor is non-blocking the iterator may fail with EAGAIN.
|
||||||
|
@ -94,15 +94,15 @@ module "nixio.UnifiedIO"
|
||||||
-- @name UnifiedIO.copy
|
-- @name UnifiedIO.copy
|
||||||
-- @usage This function uses the blocksource function of the source descriptor
|
-- @usage This function uses the blocksource function of the source descriptor
|
||||||
-- and the sink function of the target descriptor.
|
-- and the sink function of the target descriptor.
|
||||||
-- @usage If the limit parameter is ommited, data is copied
|
-- @usage If the limit parameter is omitted, data is copied
|
||||||
-- until an end-of-file, end-of-stream, connection shutdown or similar happens.
|
-- 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.
|
-- @usage If the descriptor is non-blocking the function may fail with EAGAIN.
|
||||||
-- @param fdout Target Descriptor
|
-- @param fdout Target Descriptor
|
||||||
-- @param size Bytes to copy (optional)
|
-- @param size Bytes to copy (optional)
|
||||||
-- @return bytes that were successfully written if no error occured
|
-- @return bytes that were successfully written if no error occurred
|
||||||
-- @return - reserved for error code -
|
-- @return - reserved for error code -
|
||||||
-- @return - reserved for error message -
|
-- @return - reserved for error message -
|
||||||
-- @return bytes that were successfully written even if an error occured
|
-- @return bytes that were successfully written even if an error occurred
|
||||||
|
|
||||||
--- Copy data from the current descriptor to another one using kernel-space
|
--- Copy data from the current descriptor to another one using kernel-space
|
||||||
-- copying if possible.
|
-- copying if possible.
|
||||||
|
@ -111,19 +111,19 @@ module "nixio.UnifiedIO"
|
||||||
-- @usage This function uses the sendfile() syscall to copy the data or the
|
-- @usage This function uses the sendfile() syscall to copy the data or the
|
||||||
-- blocksource function of the source descriptor and the sink function
|
-- blocksource function of the source descriptor and the sink function
|
||||||
-- of the target descriptor as a fallback mechanism.
|
-- of the target descriptor as a fallback mechanism.
|
||||||
-- @usage If the limit parameter is ommited, data is copied
|
-- @usage If the limit parameter is omitted, data is copied
|
||||||
-- until an end-of-file, end-of-stream, connection shutdown or similar happens.
|
-- 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.
|
-- @usage If the descriptor is non-blocking the function may fail with EAGAIN.
|
||||||
-- @param fdout Target Descriptor
|
-- @param fdout Target Descriptor
|
||||||
-- @param size Bytes to copy (optional)
|
-- @param size Bytes to copy (optional)
|
||||||
-- @return bytes that were successfully written if no error occured
|
-- @return bytes that were successfully written if no error occurred
|
||||||
-- @return - reserved for error code -
|
-- @return - reserved for error code -
|
||||||
-- @return - reserved for error message -
|
-- @return - reserved for error message -
|
||||||
-- @return bytes that were successfully written even if an error occured
|
-- @return bytes that were successfully written even if an error occurred
|
||||||
|
|
||||||
--- Close the descriptor.
|
--- Close the descriptor.
|
||||||
-- @class function
|
-- @class function
|
||||||
-- @name UnifiedIO.close
|
-- @name UnifiedIO.close
|
||||||
-- @usage If the descriptor is a TLS-socket the underlying descriptor is
|
-- @usage If the descriptor is a TLS-socket the underlying descriptor is
|
||||||
-- closed without touching the TLS connection.
|
-- closed without touching the TLS connection.
|
||||||
-- @return true
|
-- @return true
|
||||||
|
|
|
@ -47,7 +47,7 @@ module "nixio.fs"
|
||||||
-- @name nixio.fs.rename
|
-- @name nixio.fs.rename
|
||||||
-- @param src Source path
|
-- @param src Source path
|
||||||
-- @param dest Destination path
|
-- @param dest Destination path
|
||||||
-- @usage It is normally not possible to rename files accross filesystems.
|
-- @usage It is normally not possible to rename files across filesystems.
|
||||||
-- @return true
|
-- @return true
|
||||||
|
|
||||||
--- Remove an empty directory.
|
--- Remove an empty directory.
|
||||||
|
@ -262,4 +262,4 @@ module "nixio.fs"
|
||||||
-- omit the basename even if source and destination basename are equal.
|
-- omit the basename even if source and destination basename are equal.
|
||||||
-- @param src Source path
|
-- @param src Source path
|
||||||
-- @param dest Destination path
|
-- @param dest Destination path
|
||||||
-- @return true
|
-- @return true
|
||||||
|
|
|
@ -118,7 +118,7 @@ module "nixio"
|
||||||
-- @param flag1 First Flag ["append", "creat", "excl", "nonblock", "ndelay",
|
-- @param flag1 First Flag ["append", "creat", "excl", "nonblock", "ndelay",
|
||||||
-- "sync", "trunc", "rdonly", "wronly", "rdwr"]
|
-- "sync", "trunc", "rdonly", "wronly", "rdwr"]
|
||||||
-- @param ... More Flags [-"-]
|
-- @param ... More Flags [-"-]
|
||||||
-- @return flag to be used as second paramter to open
|
-- @return flag to be used as second parameter to open
|
||||||
|
|
||||||
--- Duplicate a file descriptor.
|
--- Duplicate a file descriptor.
|
||||||
-- @class function
|
-- @class function
|
||||||
|
@ -167,7 +167,7 @@ module "nixio"
|
||||||
|
|
||||||
--- Wait for some event on a file descriptor.
|
--- Wait for some event on a file descriptor.
|
||||||
-- poll() sets the revents-field of the tables provided by fds to a bitfield
|
-- poll() sets the revents-field of the tables provided by fds to a bitfield
|
||||||
-- indicating the events that occured.
|
-- indicating the events that occurred.
|
||||||
-- @class function
|
-- @class function
|
||||||
-- @usage This function works in-place on the provided table and only
|
-- @usage This function works in-place on the provided table and only
|
||||||
-- writes the revents field, you can use other fields on your demand.
|
-- writes the revents field, you can use other fields on your demand.
|
||||||
|
@ -303,7 +303,7 @@ module "nixio"
|
||||||
--- Set or unset a environment variable.
|
--- Set or unset a environment variable.
|
||||||
-- @class function
|
-- @class function
|
||||||
-- @name nixio.setenv
|
-- @name nixio.setenv
|
||||||
-- @usage The environment variable will be unset if value is ommited.
|
-- @usage The environment variable will be unset if value is omitted.
|
||||||
-- @param variable Variable
|
-- @param variable Variable
|
||||||
-- @param value Value (optional)
|
-- @param value Value (optional)
|
||||||
-- @return true
|
-- @return true
|
||||||
|
|
Loading…
Reference in a new issue