From 6f7b8e3f5bc0eaea00f479d6197d5381970ecff1 Mon Sep 17 00:00:00 2001 From: Stefan Weil Date: Sat, 26 Mar 2016 10:11:33 +0100 Subject: documentation: Fix typos (found by codespell) Signed-off-by: Stefan Weil --- documentation/api/modules/luci.http.protocol.html | 4 ++-- documentation/api/modules/luci.ip.cidr.html | 14 ++++++------ documentation/api/modules/luci.util.html | 6 +++--- documentation/api/modules/nixio.README.html | 6 +++--- documentation/api/modules/nixio.Socket.html | 2 +- documentation/api/modules/nixio.UnifiedIO.html | 26 +++++++++++------------ documentation/api/modules/nixio.fs.html | 2 +- documentation/api/modules/nixio.html | 6 +++--- 8 files changed, 33 insertions(+), 33 deletions(-) (limited to 'documentation/api/modules') diff --git a/documentation/api/modules/luci.http.protocol.html b/documentation/api/modules/luci.http.protocol.html index 1d45acede..57063bbcf 100644 --- a/documentation/api/modules/luci.http.protocol.html +++ b/documentation/api/modules/luci.http.protocol.html @@ -341,7 +341,7 @@ Ltn12 source function Decode a mime encoded http message body with multipart/form-data Content-Type. Stores all extracted data associated with its parameter name -in the params table withing the given message object. Multiple parameter +in the params table within the given message object. Multiple parameter values are stored as tables, ordinary ones as strings. If an optional file callback function is given then it is feeded with the file contents chunk by chunk and only the extracted file name is stored @@ -556,7 +556,7 @@ The decoded string Decode an urlencoded http message body with application/x-www-urlencoded Content-Type. Stores all extracted data associated with its parameter name -in the params table withing the given message object. Multiple parameter +in the params table within the given message object. Multiple parameter values are stored as tables, ordinary ones as strings. diff --git a/documentation/api/modules/luci.ip.cidr.html b/documentation/api/modules/luci.ip.cidr.html index 28fb21d02..ce8c56795 100644 --- a/documentation/api/modules/luci.ip.cidr.html +++ b/documentation/api/modules/luci.ip.cidr.html @@ -340,7 +340,7 @@ Add given amount to CIDR instance. cidr:sub (amount, inplace) -Substract given amount from CIDR instance. +Subtract given amount from CIDR instance. @@ -1082,7 +1082,7 @@ print(addr) -- "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/64"Return value: diff --git a/documentation/api/modules/luci.util.html b/documentation/api/modules/luci.util.html index 301cffff6..847230bbb 100644 --- a/documentation/api/modules/luci.util.html +++ b/documentation/api/modules/luci.util.html @@ -241,7 +241,7 @@ Clones the given object and return it's copy. cmatch (str, pattern) -Count the occurences of given substring in given string. +Count the occurrences of given substring in given string. @@ -629,7 +629,7 @@ Cloned table value
-Count the occurences of given substring in given string. +Count the occurrences of given substring in given string. @@ -652,7 +652,7 @@ Count the occurences of given substring in given string.

Return value:

-Number of found occurences +Number of found occurrences diff --git a/documentation/api/modules/nixio.README.html b/documentation/api/modules/nixio.README.html index a8da0f36d..d8a17f78b 100644 --- a/documentation/api/modules/nixio.README.html +++ b/documentation/api/modules/nixio.README.html @@ -288,7 +288,7 @@
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 @@ -296,10 +296,10 @@
  • 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 pratical 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.)
    • diff --git a/documentation/api/modules/nixio.Socket.html b/documentation/api/modules/nixio.Socket.html index 105682ced..7d258fc19 100644 --- a/documentation/api/modules/nixio.Socket.html +++ b/documentation/api/modules/nixio.Socket.html @@ -763,7 +763,7 @@ buffer containing data successfully read Send a message on the socket. 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.

    Parameters

    diff --git a/documentation/api/modules/nixio.UnifiedIO.html b/documentation/api/modules/nixio.UnifiedIO.html index 22e6e9165..171798084 100644 --- a/documentation/api/modules/nixio.UnifiedIO.html +++ b/documentation/api/modules/nixio.UnifiedIO.html @@ -326,7 +326,7 @@
  • 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 the limit parameter is ommited, the iterator returns data +
  • If the limit parameter is omitted, the iterator returns data until an end-of-file, end-of-stream, connection shutdown or similar happens.
  • The iterator will not buffer so it is safe to mix with calls to read. @@ -402,7 +402,7 @@ true
  • This function uses the blocksource function of the source descriptor and the sink function of the target descriptor. -
  • If the limit parameter is ommited, data is copied +
  • If the limit parameter is omitted, data is copied until an end-of-file, end-of-stream, connection shutdown or similar happens.
  • If the descriptor is non-blocking the function may fail with EAGAIN. @@ -414,13 +414,13 @@ true

    Return values:

      -
    1. bytes that were successfully written if no error occured +
    2. bytes that were successfully written if no error occurred
    3. - reserved for error code -
    4. - reserved for error message - -
    5. bytes that were successfully written even if an error occured +
    6. bytes that were successfully written even if an error occurred
    @@ -461,7 +461,7 @@ true blocksource function of the source descriptor and the sink function of the target descriptor as a fallback mechanism. -
  • If the limit parameter is ommited, data is copied +
  • If the limit parameter is omitted, data is copied until an end-of-file, end-of-stream, connection shutdown or similar happens.
  • If the descriptor is non-blocking the function may fail with EAGAIN. @@ -473,13 +473,13 @@ true

    Return values:

      -
    1. bytes that were successfully written if no error occured +
    2. bytes that were successfully written if no error occurred
    3. - reserved for error code -
    4. - reserved for error message - -
    5. bytes that were successfully written even if an error occured +
    6. bytes that were successfully written even if an error occurred
    @@ -584,7 +584,7 @@ boolean you can pass "true" to the iterator which will flush the buffer and return the bufferd data. -
  • If the limit parameter is ommited, this function uses the nixio +
  • If the limit parameter is omitted, this function uses the nixio buffersize (8192B by default).
  • If the descriptor is non-blocking the iterator may fail with EAGAIN. @@ -628,7 +628,7 @@ Line-based Iterator
  • This function uses the low-level read function of the descriptor. -
  • If the length parameter is ommited, this function returns all data +
  • 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. @@ -641,13 +641,13 @@ Line-based Iterator

    Return values:

      -
    1. data that was successfully read if no error occured +
    2. data that was successfully read if no error occurred
    3. - reserved for error code -
    4. - reserved for error message - -
    5. data that was successfully read even if an error occured +
    6. data that was successfully read even if an error occurred
    @@ -733,13 +733,13 @@ Sink

    Return values:

      -
    1. bytes that were successfully written if no error occured +
    2. bytes that were successfully written if no error occurred
    3. - reserved for error code -
    4. - reserved for error message - -
    5. bytes that were successfully written even if an error occured +
    6. bytes that were successfully written even if an error occurred
    diff --git a/documentation/api/modules/nixio.fs.html b/documentation/api/modules/nixio.fs.html index d4fda2c51..40d0a0636 100644 --- a/documentation/api/modules/nixio.fs.html +++ b/documentation/api/modules/nixio.fs.html @@ -1274,7 +1274,7 @@ true

    Usage:

    -It is normally not possible to rename files accross fileystems. +It is normally not possible to rename files across fileystems. diff --git a/documentation/api/modules/nixio.html b/documentation/api/modules/nixio.html index f02fe3be5..8ee0f62dc 100644 --- a/documentation/api/modules/nixio.html +++ b/documentation/api/modules/nixio.html @@ -1594,7 +1594,7 @@ File Object

    Return value:

    -flag to be used as second paramter to open +flag to be used as second parameter to open @@ -1670,7 +1670,7 @@ flag to be used as second paramter to open Wait for some event on a file descriptor. poll() sets the revents-field of the tables provided by fds to a bitfield - indicating the events that occured. + indicating the events that occurred.

    Parameters

    @@ -1846,7 +1846,7 @@ bytes sent

    Usage:

    -The environment variable will be unset if value is ommited. +The environment variable will be unset if value is omitted. -- cgit v1.2.3