documentation: Fix typos (found by codespell) 689/head
authorStefan Weil <sw@weilnetz.de>
Sat, 26 Mar 2016 09:11:33 +0000 (10:11 +0100)
committerStefan Weil <sw@weilnetz.de>
Sat, 26 Mar 2016 09:20:46 +0000 (10:20 +0100)
Signed-off-by: Stefan Weil <sw@weilnetz.de>
documentation/CBI.md
documentation/LAR.md
documentation/ThemesHowTo.md
documentation/api/modules/luci.http.protocol.html
documentation/api/modules/luci.ip.cidr.html
documentation/api/modules/luci.util.html
documentation/api/modules/nixio.README.html
documentation/api/modules/nixio.Socket.html
documentation/api/modules/nixio.UnifiedIO.html
documentation/api/modules/nixio.fs.html
documentation/api/modules/nixio.html

index 4ebc08af098aa7ceee521ea9eee18598578a6e2b..e937fe6048a84cb7a75442e0e1203f9302e0bebd 100644 (file)
@@ -164,7 +164,7 @@ If you call this function several times the dependencies will be linked with **"
 The default value
 
 #### 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
 the value that should be set if the checkbox is checked
index f44d8dc7df970e9a4effb3f851ac0837d31f6604..457b076f9a8f4c079c242969e68cc9b851469c3d 100644 (file)
@@ -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
index 32154c724c321ce92da38e570abe37a411b4508d..ae6f8e09cdaea5832cfff56d4ebb764c38852e9c 100644 (file)
@@ -1,7 +1,7 @@
 # HowTo: Create Themes
 *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.
 
 
 
index 1d45acede6bb298826b5f48a4890c816d31518c2..57063bbcf92b32a57fc8e0f5f672b133759cd8b6 100644 (file)
@@ -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.
 
 
index 28fb21d02dcedc9a9268aede2abc62ff2679d7c1..ce8c567952c230c469d2f3a85513e66593391d1e 100644 (file)
@@ -340,7 +340,7 @@ Add given amount to CIDR instance.</td>
        <td class="name" nowrap><a href="#cidr.sub">cidr:sub</a>&nbsp;(amount, inplace)</td>
        <td class="summary">
  
-Substract given amount from CIDR instance.</td>
+Subtract given amount from CIDR instance.</td>
        </tr>
 
        <tr>
@@ -1082,7 +1082,7 @@ print(addr)                  -- "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/64"</pr
 
 <h3>Return value:</h3>
 <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> 
        <li>When deriving new CIDR: Return new instance representing the value of 
         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>
 
  
-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. 
 
 
@@ -1148,11 +1148,11 @@ print(addr)                  -- "::/64"</pre>
 
 <h3>Return value:</h3>
 <ul> 
-       <li>When substracting inplace: Return <code>true</code> if the substraction 
-           succeded or <code>false</code> when the substraction underflowed.</li> 
+       <li>When subtracting inplace: Return <code>true</code> if the subtraction
+           succeeded or <code>false</code> when the subtraction underflowed.</li>
        <li>When deriving new CIDR: Return new instance representing the value of 
-        this instance minus the substracted amount or the lowest address if 
-           the substraction underflowed.</li></ul>
+        this instance minus the subtracted amount or the lowest address if
+           the subtraction underflowed.</li></ul>
 
 
 
index 301cffff68523f0c4ef12c041b894acd39ba17c6..847230bbbda4fbb443ea0ccf5e1f3a481c07749b 100644 (file)
@@ -241,7 +241,7 @@ Clones the given object and return it's copy.</td>
        <td class="name" nowrap><a href="#cmatch">cmatch</a>&nbsp;(str, pattern)</td>
        <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>
@@ -629,7 +629,7 @@ Cloned table value
 <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>
-Number of found occurences
+Number of found occurrences
 
 
 
index a8da0f36dadde3449a3f553884d629ac84b130f2..d8a17f78b40a5c15ead7f15376fc6fd6dab635ad 100644 (file)
  <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 ommiting 
+ <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 
  <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 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 
  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.) </li> 
index 105682ced25e1e342661e074e8d6a54f60b0383d..7d258fc195debd65ed7fc1daaeeb2bad2a22990c 100644 (file)
@@ -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.
 
 
 <h3>Parameters</h3>
index 22e6e91658fc3ac6595bc45e9147f070844df002..1717980841eb46eaf86bd5de833abc5c8d602747 100644 (file)
        <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 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.
        
        <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 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.
        
        <li>If the descriptor is non-blocking the function may fail with EAGAIN.
@@ -414,13 +414,13 @@ true
 <h3>Return values:</h3>
 <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 message -
        
-       <li>bytes that were successfully written even if an error occured
+       <li>bytes that were successfully written even if an error occurred
        
 </ol>
 
@@ -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 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.
        
        <li>If the descriptor is non-blocking the function may fail with EAGAIN.
@@ -473,13 +473,13 @@ true
 <h3>Return values:</h3>
 <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 message -
        
-       <li>bytes that were successfully written even if an error occured
+       <li>bytes that were successfully written even if an error occurred
        
 </ol>
 
@@ -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 ommited, 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 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 
  or similar happens.
        
@@ -641,13 +641,13 @@ Line-based Iterator
 <h3>Return values:</h3>
 <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 message -
        
-       <li>data that was successfully read even if an error occured
+       <li>data that was successfully read even if an error occurred
        
 </ol>
 
@@ -733,13 +733,13 @@ Sink
 <h3>Return values:</h3>
 <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 message -
        
-       <li>bytes that were successfully written even if an error occured
+       <li>bytes that were successfully written even if an error occurred
        
 </ol>
 
index d4fda2c516142f349dc3a65d55134f9e4fe7b561..40d0a0636e7dba1fbb3b98b8277039c225969259 100644 (file)
@@ -1274,7 +1274,7 @@ true
 
 
 <h3>Usage:</h3>
-It is normally not possible to rename files accross fileystems.
+It is normally not possible to rename files across fileystems.
 
 
 
index f02fe3be58fdd8c7ae25edb4a0446b6b6a371a75..8ee0f62dc774fe821e536143ada619c828824451 100644 (file)
@@ -1594,7 +1594,7 @@ File Object
 
 
 <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. 
  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>
@@ -1846,7 +1846,7 @@ bytes sent
 
 
 <h3>Usage:</h3>
-The environment variable will be unset if value is ommited.
+The environment variable will be unset if value is omitted.