You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by ad...@apache.org on 2016/05/27 20:48:20 UTC

[2/2] incubator-mynewt-site git commit: Fix spelling mistakes / typos

Fix spelling mistakes / typos

Just a quick mechanical check with the 'codespell' tool. I ignored the 3rd
party Javascript files for this changeset.

Signed-off-by: Sam Bristow <sa...@gmail.com>

This closes #89


Project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/commit/c3246c74
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/c3246c74
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/c3246c74

Branch: refs/heads/master
Commit: c3246c74c40a1d4d84fc17533c3cf89726dcbd70
Parents: 45da113
Author: Sam Bristow <sa...@gmail.com>
Authored: Thu May 26 18:40:50 2016 +1200
Committer: aditihilbert <ad...@runtime.io>
Committed: Fri May 27 13:45:38 2016 -0700

----------------------------------------------------------------------
 build.sh                                       | 2 +-
 docs/network/ble/nimble_setup.md               | 2 +-
 docs/newt/install/newt_linux.md                | 4 ++--
 docs/newt/install/newt_mac.md                  | 4 ++--
 docs/os/core_os/mbuf/mbuf.md                   | 2 +-
 docs/os/core_os/memory_pool/os_memblock_get.md | 2 +-
 docs/os/get_started/vocabulary.md              | 2 +-
 docs/os/modules/fs/fs/fs_unlink.md             | 2 +-
 docs/os/modules/fs/nffs/nffs_internals.md      | 4 ++--
 docs/os/modules/hal/hal_i2c/hal_i2c.md         | 2 +-
 docs/os/modules/imgmgr/imgr_ver_str.md         | 2 +-
 docs/os/tutorials/STM32F303.md                 | 2 +-
 docs/os/tutorials/air_quality_sensor.md        | 2 +-
 docs/os/tutorials/nRF52.md                     | 2 +-
 docs/os/tutorials/nimble_setup_copy.md         | 2 +-
 docs/os/tutorials/olimex.md                    | 2 +-
 docs/os/tutorials/project-target-slinky.md     | 2 +-
 docs/os/tutorials/unit_test.md                 | 2 +-
 18 files changed, 21 insertions(+), 21 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c3246c74/build.sh
----------------------------------------------------------------------
diff --git a/build.sh b/build.sh
index cc47173..6d4b8c1 100755
--- a/build.sh
+++ b/build.sh
@@ -28,7 +28,7 @@ cp -a site/ .
 
 echo ---
 echo --- You are now on the asf-site branch
-echo --- Review git diffs before commiting
+echo --- Review git diffs before committing
 echo ---
 git status
 

http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c3246c74/docs/network/ble/nimble_setup.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/nimble_setup.md b/docs/network/ble/nimble_setup.md
index 6715740..8644caf 100644
--- a/docs/network/ble/nimble_setup.md
+++ b/docs/network/ble/nimble_setup.md
@@ -203,7 +203,7 @@ App successfully built: /Users/wes/dev/my_proj1/bin/ble_tgt/apps/ble_app/ble_app
 
 You now have a fully functional BLE app (never mind the fact that it doesn't
 actually do anything yet!).  With all the necessary infrastructure in place,
-you can now start turning this into a real applicaiton.  Additional tutorials
+you can now start turning this into a real application.  Additional tutorials
 with focus on adding application-layer functionality to your Nimble application
 will be coming soon.  In the meantime, you might get some inspiration from
 apache-mynewt-core's example Nimble apps.  These apps can be found at the below locations, relative to your project's base directory:

http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c3246c74/docs/newt/install/newt_linux.md
----------------------------------------------------------------------
diff --git a/docs/newt/install/newt_linux.md b/docs/newt/install/newt_linux.md
index dcc82a8..6f2509b 100644
--- a/docs/newt/install/newt_linux.md
+++ b/docs/newt/install/newt_linux.md
@@ -17,7 +17,7 @@ If you want to build the *newt* tool from its source code, follow the following
 
 #### 2. Install Go, the programming language
 
-* Go language enviroment dictates a directory structure. Known in Go parlanace as workspace, it must contain three sibling directories with the directory names src, pkg and bin, as explained below. 
+* Go language environment dictates a directory structure. Known in Go parlanace as workspace, it must contain three sibling directories with the directory names src, pkg and bin, as explained below. 
 
     * src contains Go source files organized into packages (one package per directory),
 
@@ -44,7 +44,7 @@ If you want to build the *newt* tool from its source code, follow the following
 
 <br>
 
-* Next, install Go. When installed, Go offers you as a developer a language enviroment (to compile Go code), construct Go packages (to assemble Go packages) and import Go code (from github). In the next step, you will use the Go commands to import *newt* repo into your local Go environment.
+* Next, install Go. When installed, Go offers you as a developer a language environment (to compile Go code), construct Go packages (to assemble Go packages) and import Go code (from github). In the next step, you will use the Go commands to import *newt* repo into your local Go environment.
 
     **Note**: The Newt tool requires Go version 1.5 or later. It uses the support for "vendoring" that was added in Go 1.5. Depending on the Ubuntu version you have, the following may install an earlier version. In that case, download the latest package of Go 1.5 or 1.6 from [https://golang.org/dl/](https://golang.org/dl/). You can search for more detailed instructions such as installing Go 1.6 on Ubuntu 14.04 which can be found at [https://www.digitalocean.com/community/tutorials/how-to-install-go-1-6-on-ubuntu-14-04](https://www.digitalocean.com/community/tutorials/how-to-install-go-1-6-on-ubuntu-14-04).
    

http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c3246c74/docs/newt/install/newt_mac.md
----------------------------------------------------------------------
diff --git a/docs/newt/install/newt_mac.md b/docs/newt/install/newt_mac.md
index 7163f3f..0da1503 100644
--- a/docs/newt/install/newt_mac.md
+++ b/docs/newt/install/newt_mac.md
@@ -19,7 +19,7 @@ If you want to build the *newt* tool from its source code, follow the following
 
 #### 2. Install Go, the programming language
 
-* Go language enviroment dictates a directory structure. Known in Go parlanace as workspace, it must contain three sibling directories with the directory names src, pkg and bin, as explained below. 
+* Go language environment dictates a directory structure. Known in Go parlanace as workspace, it must contain three sibling directories with the directory names src, pkg and bin, as explained below. 
 
     * src contains Go source files organized into packages (one package per directory),
 
@@ -48,7 +48,7 @@ If you want to build the *newt* tool from its source code, follow the following
 
 <br>
 
-* Next, using *brew*, install Go. When installed, Go offers you as a developer a language enviroment (to compile Go code), construct Go packages (to assemble Go packages) and import Go code (from github). In the next step, you will use the Go commands to import *newt* repo into your local Go environment.
+* Next, using *brew*, install Go. When installed, Go offers you as a developer a language environment (to compile Go code), construct Go packages (to assemble Go packages) and import Go code (from github). In the next step, you will use the Go commands to import *newt* repo into your local Go environment.
      
 ```no-highlight
         $ brew install go

http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c3246c74/docs/os/core_os/mbuf/mbuf.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/mbuf/mbuf.md b/docs/os/core_os/mbuf/mbuf.md
index 826d620..a6b338a 100644
--- a/docs/os/core_os/mbuf/mbuf.md
+++ b/docs/os/core_os/mbuf/mbuf.md
@@ -148,7 +148,7 @@ mbuf_usage_example2(struct mbuf *rxpkt)
 	    }
 	}
 	
-	/* Free passed in packet (mbuf chain) since we dont need it anymore */
+	/* Free passed in packet (mbuf chain) since we don't need it anymore */
 	os_mbuf_free_chain(om);
 }
 

http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c3246c74/docs/os/core_os/memory_pool/os_memblock_get.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/memory_pool/os_memblock_get.md b/docs/os/core_os/memory_pool/os_memblock_get.md
index 2a3c9fb..e341d4f 100644
--- a/docs/os/core_os/memory_pool/os_memblock_get.md
+++ b/docs/os/core_os/memory_pool/os_memblock_get.md
@@ -4,7 +4,7 @@
 void *os_memblock_get(struct os_mempool *mp)
 ```
 
-Allocate an element from the memory pool. If succesful, you'll get a pointer to allocated element. If there are no elements available, you'll get NULL as response.
+Allocate an element from the memory pool. If successful, you'll get a pointer to allocated element. If there are no elements available, you'll get NULL as response.
 
 
 #### Arguments

http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c3246c74/docs/os/get_started/vocabulary.md
----------------------------------------------------------------------
diff --git a/docs/os/get_started/vocabulary.md b/docs/os/get_started/vocabulary.md
index 8598a40..3377f17 100644
--- a/docs/os/get_started/vocabulary.md
+++ b/docs/os/get_started/vocabulary.md
@@ -110,7 +110,7 @@ Dependencies and APIs to the rest of the system.
 ### Target
 
 A target in Apache Mynewt is very similar to a target in *make*.  It is the collection
-of parameters that must be passed to Newt in order to generate a reproducable build.  A 
+of parameters that must be passed to Newt in order to generate a reproducible build.  A 
 target represents the top of the build tree, and any packages or parameters specified at 
 the target level, cascade down to all dependencies.
 

http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c3246c74/docs/os/modules/fs/fs/fs_unlink.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/fs/fs/fs_unlink.md b/docs/os/modules/fs/fs/fs_unlink.md
index 2d1392f..8fddba9 100644
--- a/docs/os/modules/fs/fs/fs_unlink.md
+++ b/docs/os/modules/fs/fs/fs_unlink.md
@@ -4,7 +4,7 @@
 int fs_unlink(const char *filename)
 ```
 
-Unlinks the file or directory at the specified path.  This is the function to use if you want to delete a file or directory from the disk.  If the path refers to a directory, all the directory's descendants are recursively unlinked.  Any open file handles refering to an unlinked file remain valid, and can be read from and written to as long as they remain open.
+Unlinks the file or directory at the specified path.  This is the function to use if you want to delete a file or directory from the disk.  If the path refers to a directory, all the directory's descendants are recursively unlinked.  Any open file handles referring to an unlinked file remain valid, and can be read from and written to as long as they remain open.
 
 #### Arguments
 

http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c3246c74/docs/os/modules/fs/nffs/nffs_internals.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/fs/nffs/nffs_internals.md b/docs/os/modules/fs/nffs/nffs_internals.md
index 23a15b0..20b56aa 100644
--- a/docs/os/modules/fs/nffs/nffs_internals.md
+++ b/docs/os/modules/fs/nffs/nffs_internals.md
@@ -222,7 +222,7 @@ During detection, each indicated region of flash is checked for a valid area hea
 1. Verify the object's integrity via a crc16 check.  If invalid, the object is discarded and the procedure restarts on the next object in the area.
 2. Convert the disk object into its corresponding RAM representation and insert it into the hash table.  If the object is an inode, its reference count is initialized to 1, indicating ownership by its parent directory.
 3. If an object with the same ID is already present, then one supersedes the other.  Accept the object with the greater sequence number and discard the other.
-4. If the object references a nonexistant inode (parent directory in the case of an inode; owning file in the case of a data block), insert a temporary "dummy" inode into the hash table so that inter-object links can be maintained until the absent inode is eventually restored.  Dummy inodes are identified by a reference count of 0.
+4. If the object references a nonexistent inode (parent directory in the case of an inode; owning file in the case of a data block), insert a temporary "dummy" inode into the hash table so that inter-object links can be maintained until the absent inode is eventually restored.  Dummy inodes are identified by a reference count of 0.
 5. If a delete record for an inode is encountered, the inode's parent pointer is set to null to indicate that it should be removed from RAM.
 
 If nffs encounters an object that cannot be identified (i.e., its magic number is not valid), it scans the remainder of the flash area for the next valid magic number.  Upon encountering a valid object, nffs resumes the procedure described above.
@@ -308,7 +308,7 @@ Appended data can only be written to the end of the file.  That is, "holes" are
 
 # Garbage collection
 
-When the file system is too full to accomodate a write operation, the system must perform garbage collection to make room.  The garbage collection procedure is described below:
+When the file system is too full to accommodate a write operation, the system must perform garbage collection to make room.  The garbage collection procedure is described below:
 
 * The non-scratch area with the lowest garbage collection sequence number is selected as the "source area."  If there are other areas with the same sequence number, the one with the smallest flash offset is selected. 
 * The source area's ID is written to the scratch area's header, transforming it into a non-scratch ID.  This former scratch area is now known as the "destination area."

http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c3246c74/docs/os/modules/hal/hal_i2c/hal_i2c.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/hal/hal_i2c/hal_i2c.md b/docs/os/modules/hal/hal_i2c/hal_i2c.md
index 1643297..3b713c5 100644
--- a/docs/os/modules/hal/hal_i2c/hal_i2c.md
+++ b/docs/os/modules/hal/hal_i2c/hal_i2c.md
@@ -69,7 +69,7 @@ As an example, consider an  I�C  device address that looks like this:
 |MSB|   |   |   |   |   |   |LSB|
 
 In the HAL_I2C API you would communicate with this device with address 
-`0b1000110`, whic is hex 0x46 or decimal 70.  The I�C drive would add the R/W bit
+`0b1000110`, which is hex 0x46 or decimal 70.  The I�C drive would add the R/W bit
 and transmit it as hex 0x8D or 0x8D depending whether it was a read or
 write command.
 

http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c3246c74/docs/os/modules/imgmgr/imgr_ver_str.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/imgmgr/imgr_ver_str.md b/docs/os/modules/imgmgr/imgr_ver_str.md
index 605068f..0b9d992 100644
--- a/docs/os/modules/imgmgr/imgr_ver_str.md
+++ b/docs/os/modules/imgmgr/imgr_ver_str.md
@@ -5,7 +5,7 @@
    imgr_ver_str(struct image_version *ver, char *dst)
 ```
 
-  Takes the version string from `ver` and formats that into a printable string to `dst`. Caller must make sure that `dst` contains enough space to hold maximum lenght version string. The convenience defininition for max length version string is named `IMGMGR_MAX_VER_STR`.
+  Takes the version string from `ver` and formats that into a printable string to `dst`. Caller must make sure that `dst` contains enough space to hold maximum length version string. The convenience defininition for max length version string is named `IMGMGR_MAX_VER_STR`.
   
 
 #### Arguments

http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c3246c74/docs/os/tutorials/STM32F303.md
----------------------------------------------------------------------
diff --git a/docs/os/tutorials/STM32F303.md b/docs/os/tutorials/STM32F303.md
index 7647d55..4e546b5 100644
--- a/docs/os/tutorials/STM32F303.md
+++ b/docs/os/tutorials/STM32F303.md
@@ -173,7 +173,7 @@ image an arbitrary version `1.2.3`.
 
 ```no-highlight
 $ newt create-image stmf3_blinky 1.2.3
-App image succesfully generated: ~/dev/myproj/bin/stmf3_blinky/apps/blinky/blinky.img
+App image successfully generated: ~/dev/myproj/bin/stmf3_blinky/apps/blinky/blinky.img
 Build manifest:~/dev/myproj/bin/stmf3_blinky/apps/blinky/manifest.json
 ```
 

http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c3246c74/docs/os/tutorials/air_quality_sensor.md
----------------------------------------------------------------------
diff --git a/docs/os/tutorials/air_quality_sensor.md b/docs/os/tutorials/air_quality_sensor.md
index cb8e04f..655be7a 100644
--- a/docs/os/tutorials/air_quality_sensor.md
+++ b/docs/os/tutorials/air_quality_sensor.md
@@ -133,7 +133,7 @@ Ah. Forgot to create an image out of the blinky binary. Note that every time you
 
 ```no-highlight
 [user@IsMyLaptop:~/src/air_quality]$ newt create-image blink_f3 0.0.1
-App image succesfully generated: /Users/user/src/air_quality/bin/blink_f3/apps/blinky/blinky.img
+App image successfully generated: /Users/user/src/air_quality/bin/blink_f3/apps/blinky/blinky.img
 Build manifest: /Users/user/src/air_quality/bin/blink_f3/apps/blinky/manifest.json
 [user@IsMyLaptop:~/src/air_quality]$ newt load blink_f3 0.0.1
 ```

http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c3246c74/docs/os/tutorials/nRF52.md
----------------------------------------------------------------------
diff --git a/docs/os/tutorials/nRF52.md b/docs/os/tutorials/nRF52.md
index b3b746e..15e5171 100644
--- a/docs/os/tutorials/nRF52.md
+++ b/docs/os/tutorials/nRF52.md
@@ -118,7 +118,7 @@ You must sign and version your application image to download it using newt to th
 
 ```
 $ newt create-image blink_nordic 1.0.0
-App image succesfully generated: ~/dev/myproj/bin/blink_nordic/apps/blinky/blinky.img
+App image successfully generated: ~/dev/myproj/bin/blink_nordic/apps/blinky/blinky.img
 Build manifest: ~/dev/myproj/bin/blink_nordic/apps/blinky/manifest.json
 ```
 

http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c3246c74/docs/os/tutorials/nimble_setup_copy.md
----------------------------------------------------------------------
diff --git a/docs/os/tutorials/nimble_setup_copy.md b/docs/os/tutorials/nimble_setup_copy.md
index e4b8700..f1bce25 100644
--- a/docs/os/tutorials/nimble_setup_copy.md
+++ b/docs/os/tutorials/nimble_setup_copy.md
@@ -534,7 +534,7 @@ App successfully built: /Users/wes/dev/larva/bin/ble_tgt/apps/ble_app/ble_app.el
 
 You now have a fully functional BLE app (never mind the fact that it doesn't
 actually do anything yet!).  With all the necessary infrastructure in place,
-you can now start turning this into a real applicaiton.  Additional tutorials
+you can now start turning this into a real application.  Additional tutorials
 with focus on adding application-layer functionality to your Nimble application
 will be coming soon.  In the meantime, you might get some inspiration from
 apache-mynewt-core's example Nimble apps.  These apps can be found at the below locations, relative to your project's base directory:

http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c3246c74/docs/os/tutorials/olimex.md
----------------------------------------------------------------------
diff --git a/docs/os/tutorials/olimex.md b/docs/os/tutorials/olimex.md
index 9b8f3af..740c293 100644
--- a/docs/os/tutorials/olimex.md
+++ b/docs/os/tutorials/olimex.md
@@ -112,7 +112,7 @@ You must sign and version your application image to download it using newt to th
 
 ```
 $ newt create-image blinky 1.0.0
-App image succesfully generated: ~/dev/myproj/bin/blinky/apps/blinky/blinky.img
+App image successfully generated: ~/dev/myproj/bin/blinky/apps/blinky/blinky.img
 Build manifest: ~/dev/myproj/bin/blinky/apps/blinky/manifest.json
 ```
 

http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c3246c74/docs/os/tutorials/project-target-slinky.md
----------------------------------------------------------------------
diff --git a/docs/os/tutorials/project-target-slinky.md b/docs/os/tutorials/project-target-slinky.md
index e51b8d6..8f71650 100644
--- a/docs/os/tutorials/project-target-slinky.md
+++ b/docs/os/tutorials/project-target-slinky.md
@@ -106,7 +106,7 @@ Give this image some arbitrary version number "1.2.3".
 
 ```no-highlight
 $ newt create-image stm32_slinky 1.2.3
-App image succesfully generated: /Users/paulfdietrich/dev/slinky/bin/stm32_slinky/apps/slinky/slinky.img
+App image successfully generated: /Users/paulfdietrich/dev/slinky/bin/stm32_slinky/apps/slinky/slinky.img
 Build manifest: /Users/paulfdietrich/dev/slinky/bin/stm32_slinky/apps/slinky/manifest.json
 ```
 

http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c3246c74/docs/os/tutorials/unit_test.md
----------------------------------------------------------------------
diff --git a/docs/os/tutorials/unit_test.md b/docs/os/tutorials/unit_test.md
index c94f819..467697f 100644
--- a/docs/os/tutorials/unit_test.md
+++ b/docs/os/tutorials/unit_test.md
@@ -165,7 +165,7 @@ At this point, you can add contents to your test and verify that
 the test suites pass.  For now, lets just add a simple failure to show
 what it would look like when running from Newt.
 
-* Edit `test_json_simple.c` and add a `TEST_ASSERT` to a test funtion. The
+* Edit `test_json_simple.c` and add a `TEST_ASSERT` to a test function. The
 test assert will fail if its argument is `false`.