documentation: Fix typos (found by codespell)
Signed-off-by: Stefan Weil <sw@weilnetz.de>
This commit is contained in:
parent
cd43e35b9d
commit
6f7b8e3f5b
11 changed files with 36 additions and 36 deletions
|
@ -164,7 +164,7 @@ If you call this function several times the dependencies will be linked with **"
|
||||||
The default value
|
The default value
|
||||||
|
|
||||||
#### property .disabled = 0
|
#### property .disabled = 0
|
||||||
the value that shoudl be set if the checkbox is unchecked
|
the value that should be set if the checkbox is unchecked
|
||||||
|
|
||||||
#### property .enabled = 1
|
#### property .enabled = 1
|
||||||
the value that should be set if the checkbox is checked
|
the value that should be set if the checkbox is checked
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
LAR is a simple archive format to pack multiple lua source files and arbitary other resources into a single file.
|
LAR is a simple archive format to pack multiple lua source files and arbitrary other resources into a single file.
|
||||||
|
|
||||||
|
|
||||||
# Format Specification
|
# Format Specification
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
# HowTo: Create Themes
|
# HowTo: Create Themes
|
||||||
*Note:* You should read the [Module Reference](Modules.md) and the [Template Reference](Templates.md) before.
|
*Note:* You should read the [Module Reference](Modules.md) and the [Template Reference](Templates.md) before.
|
||||||
|
|
||||||
We assume you want to call your new theme _mytheme_. Make sure you replace this by your module name everytime this is mentionend in this Howto.
|
We assume you want to call your new theme _mytheme_. Make sure you replace this by your module name every time this is mentionend in this Howto.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -341,7 +341,7 @@ Ltn12 source function
|
||||||
Decode a mime encoded http message body with multipart/form-data
|
Decode a mime encoded http message body with multipart/form-data
|
||||||
|
|
||||||
Content-Type. Stores all extracted data associated with its parameter name
|
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.
|
values are stored as tables, ordinary ones as strings.
|
||||||
If an optional file callback function is given then it is feeded with the
|
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
|
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
|
Decode an urlencoded http message body with application/x-www-urlencoded
|
||||||
|
|
||||||
Content-Type. Stores all extracted data associated with its parameter name
|
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.
|
values are stored as tables, ordinary ones as strings.
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -340,7 +340,7 @@ Add given amount to CIDR instance.</td>
|
||||||
<td class="name" nowrap><a href="#cidr.sub">cidr:sub</a> (amount, inplace)</td>
|
<td class="name" nowrap><a href="#cidr.sub">cidr:sub</a> (amount, inplace)</td>
|
||||||
<td class="summary">
|
<td class="summary">
|
||||||
|
|
||||||
Substract given amount from CIDR instance.</td>
|
Subtract given amount from CIDR instance.</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
<tr>
|
<tr>
|
||||||
|
@ -1082,7 +1082,7 @@ print(addr) -- "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/64"</pr
|
||||||
|
|
||||||
<h3>Return value:</h3>
|
<h3>Return value:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li>When adding inplace: Return <code>true</code> if the addition succeded
|
<li>When adding inplace: Return <code>true</code> if the addition succeeded
|
||||||
or <code>false</code> when the addition overflowed.</li>
|
or <code>false</code> when the addition overflowed.</li>
|
||||||
<li>When deriving new CIDR: Return new instance representing the value of
|
<li>When deriving new CIDR: Return new instance representing the value of
|
||||||
this instance plus the added amount or the highest possible address if
|
this instance plus the added amount or the highest possible address if
|
||||||
|
@ -1099,7 +1099,7 @@ print(addr) -- "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/64"</pr
|
||||||
<dd>
|
<dd>
|
||||||
|
|
||||||
|
|
||||||
Substract given amount from CIDR instance. If the result would under, the lowest
|
Subtract given amount from CIDR instance. If the result would under, the lowest
|
||||||
possible address is returned.
|
possible address is returned.
|
||||||
|
|
||||||
|
|
||||||
|
@ -1148,11 +1148,11 @@ print(addr) -- "::/64"</pre>
|
||||||
|
|
||||||
<h3>Return value:</h3>
|
<h3>Return value:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li>When substracting inplace: Return <code>true</code> if the substraction
|
<li>When subtracting inplace: Return <code>true</code> if the subtraction
|
||||||
succeded or <code>false</code> when the substraction underflowed.</li>
|
succeeded or <code>false</code> when the subtraction underflowed.</li>
|
||||||
<li>When deriving new CIDR: Return new instance representing the value of
|
<li>When deriving new CIDR: Return new instance representing the value of
|
||||||
this instance minus the substracted amount or the lowest address if
|
this instance minus the subtracted amount or the lowest address if
|
||||||
the substraction underflowed.</li></ul>
|
the subtraction underflowed.</li></ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -241,7 +241,7 @@ Clones the given object and return it's copy.</td>
|
||||||
<td class="name" nowrap><a href="#cmatch">cmatch</a> (str, pattern)</td>
|
<td class="name" nowrap><a href="#cmatch">cmatch</a> (str, pattern)</td>
|
||||||
<td class="summary">
|
<td class="summary">
|
||||||
|
|
||||||
Count the occurences of given substring in given string.</td>
|
Count the occurrences of given substring in given string.</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
<tr>
|
<tr>
|
||||||
|
@ -629,7 +629,7 @@ Cloned table value
|
||||||
<dd>
|
<dd>
|
||||||
|
|
||||||
|
|
||||||
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.
|
||||||
|
|
||||||
|
|
||||||
<h3>Return value:</h3>
|
<h3>Return value:</h3>
|
||||||
Number of found occurences
|
Number of found occurrences
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -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 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
|
||||||
|
@ -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 ommitted for pratical purposes.</li>
|
by-reference parameters should be omitted for pratical 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>
|
||||||
|
|
|
@ -763,7 +763,7 @@ buffer containing data successfully read
|
||||||
|
|
||||||
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.
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters</h3>
|
<h3>Parameters</h3>
|
||||||
|
|
|
@ -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 ommited, 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 ommited, 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.
|
||||||
|
@ -414,13 +414,13 @@ true
|
||||||
<h3>Return values:</h3>
|
<h3>Return values:</h3>
|
||||||
<ol>
|
<ol>
|
||||||
|
|
||||||
<li>bytes that were successfully written if no error occured
|
<li>bytes that were successfully written if no error occurred
|
||||||
|
|
||||||
<li>- reserved for error code -
|
<li>- reserved for error code -
|
||||||
|
|
||||||
<li>- reserved for error message -
|
<li>- reserved for error message -
|
||||||
|
|
||||||
<li>bytes that were successfully written even if an error occured
|
<li>bytes that were successfully written even if an error occurred
|
||||||
|
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
|
@ -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 ommited, 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.
|
||||||
|
@ -473,13 +473,13 @@ true
|
||||||
<h3>Return values:</h3>
|
<h3>Return values:</h3>
|
||||||
<ol>
|
<ol>
|
||||||
|
|
||||||
<li>bytes that were successfully written if no error occured
|
<li>bytes that were successfully written if no error occurred
|
||||||
|
|
||||||
<li>- reserved for error code -
|
<li>- reserved for error code -
|
||||||
|
|
||||||
<li>- reserved for error message -
|
<li>- reserved for error message -
|
||||||
|
|
||||||
<li>bytes that were successfully written even if an error occured
|
<li>bytes that were successfully written even if an error occurred
|
||||||
|
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
|
@ -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 ommited, 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 ommited, 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.
|
||||||
|
|
||||||
|
@ -641,13 +641,13 @@ Line-based Iterator
|
||||||
<h3>Return values:</h3>
|
<h3>Return values:</h3>
|
||||||
<ol>
|
<ol>
|
||||||
|
|
||||||
<li>data that was successfully read if no error occured
|
<li>data that was successfully read if no error occurred
|
||||||
|
|
||||||
<li>- reserved for error code -
|
<li>- reserved for error code -
|
||||||
|
|
||||||
<li>- reserved for error message -
|
<li>- reserved for error message -
|
||||||
|
|
||||||
<li>data that was successfully read even if an error occured
|
<li>data that was successfully read even if an error occurred
|
||||||
|
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
|
@ -733,13 +733,13 @@ Sink
|
||||||
<h3>Return values:</h3>
|
<h3>Return values:</h3>
|
||||||
<ol>
|
<ol>
|
||||||
|
|
||||||
<li>bytes that were successfully written if no error occured
|
<li>bytes that were successfully written if no error occurred
|
||||||
|
|
||||||
<li>- reserved for error code -
|
<li>- reserved for error code -
|
||||||
|
|
||||||
<li>- reserved for error message -
|
<li>- reserved for error message -
|
||||||
|
|
||||||
<li>bytes that were successfully written even if an error occured
|
<li>bytes that were successfully written even if an error occurred
|
||||||
|
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
|
|
|
@ -1274,7 +1274,7 @@ true
|
||||||
|
|
||||||
|
|
||||||
<h3>Usage:</h3>
|
<h3>Usage:</h3>
|
||||||
It is normally not possible to rename files accross fileystems.
|
It is normally not possible to rename files across fileystems.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -1594,7 +1594,7 @@ File Object
|
||||||
|
|
||||||
|
|
||||||
<h3>Return value:</h3>
|
<h3>Return value:</h3>
|
||||||
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.
|
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.
|
||||||
|
|
||||||
|
|
||||||
<h3>Parameters</h3>
|
<h3>Parameters</h3>
|
||||||
|
@ -1846,7 +1846,7 @@ bytes sent
|
||||||
|
|
||||||
|
|
||||||
<h3>Usage:</h3>
|
<h3>Usage:</h3>
|
||||||
The environment variable will be unset if value is ommited.
|
The environment variable will be unset if value is omitted.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue