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/07/05 21:02:28 UTC

[4/5] incubator-mynewt-site git commit: fixed typos in fcb documentation

fixed typos in fcb documentation


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/0d7a246e
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/0d7a246e
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/0d7a246e

Branch: refs/heads/develop
Commit: 0d7a246e8d13eba2cce6ee2d9741fb4e593b1c95
Parents: c7b1a53
Author: aditihilbert <ad...@runtime.io>
Authored: Tue Jul 5 13:29:03 2016 -0700
Committer: aditihilbert <ad...@runtime.io>
Committed: Tue Jul 5 13:29:03 2016 -0700

----------------------------------------------------------------------
 docs/os/modules/fcb/fcb.md     | 10 +++++-----
 docs/os/tutorials/tutorials.md |  1 +
 mkdocs.yml                     |  2 +-
 3 files changed, 7 insertions(+), 6 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/0d7a246e/docs/os/modules/fcb/fcb.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/fcb/fcb.md b/docs/os/modules/fcb/fcb.md
index a442f28..149c857 100644
--- a/docs/os/modules/fcb/fcb.md
+++ b/docs/os/modules/fcb/fcb.md
@@ -4,11 +4,11 @@ Flash circular buffer provides an abstration through which you can treat flash l
 
 ###Description
 
-Elements in the flash contain the lenght of the element, the data within the element, and checksum over the element contents.
+Elements in the flash contain the length of the element, the data within the element, and checksum over the element contents.
 
 Storage of elements in flash is done in a FIFO fashion. When user requests space for the next element, space is located at the end of the used area. When user starts reading, the first element served is the oldest element in flash.
 
-Elements can be appended to the of the area until storage space is exhausted. User has control over what happens next; either erase oldest block of data, thereby freeing up some space, or stop writing new data until existing data has been collected. FCB treats underlying storage as an array of flash sectors; when it erases old data, it does this a sector at a time.
+Elements can be appended to the end of the area until storage space is exhausted. User has control over what happens next; either erase oldest block of data, thereby freeing up some space, or stop writing new data until existing data has been collected. FCB treats underlying storage as an array of flash sectors; when it erases old data, it does this a sector at a time.
 
 Elements in the flash are checksummed. That is how FCB detects whether writing element to flash completed ok. It will skip over entries which don't have a valid checksum.
 
@@ -50,7 +50,7 @@ struct fcb_entry {
 | fe_data_len | Number of bytes in the element.  |
 
 
-The following data structure describes the FCB itself. First part should be filled in by the user before calling fcb_init(). The second part is used by FCB for it's internal bookkeeping.
+The following data structure describes the FCB itself. First part should be filled in by the user before calling fcb_init(). The second part is used by FCB for its internal bookkeeping.
 ```c
 struct fcb {
     /* Caller of fcb_init fills this in */
@@ -73,13 +73,13 @@ struct fcb {
 |---------|-------------|
 | f_magic | Magic number in the beginning of FCB flash sector. FCB uses this when determining whether sector contains valid data or not. |
 | f_version | Current version number of the data. Also stored in flash sector header. |
-| f_sector_cnt | Number of elements it the f_sectors array. |
+| f_sector_cnt | Number of elements in the f_sectors array. |
 | f_scratch_cnt | Number of sectors to keep empty. This can be used if you need to have scratch space for garbage collecting when FCB fills up. |
 | f_sectors | Array of entries describing flash sectors to use. |
 | f_mtx | Lock protecting access to FCBs internal data. |
 | f_oldest | Pointer to flash sector containing the oldest data. This is where data is served when read is started. |
 | f_active | Flash location where the newest data is. This is used by fcb_append() to figure out where the data should go to. |
-| f_active_id | Flash sectors are assigned ever-increasing serial number. This is how FCB figures out where oldest data is on system restart. |
+| f_active_id | Flash sectors are assigned ever-increasing serial numbers. This is how FCB figures out where oldest data is on system restart. |
 | f_align | Some flashes have restrictions on alignment for writes. FCB keeps a copy of this number for the flash here. |
 
 ###List of Functions

http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/0d7a246e/docs/os/tutorials/tutorials.md
----------------------------------------------------------------------
diff --git a/docs/os/tutorials/tutorials.md b/docs/os/tutorials/tutorials.md
index 59e2dae..3aaaeb2 100644
--- a/docs/os/tutorials/tutorials.md
+++ b/docs/os/tutorials/tutorials.md
@@ -39,6 +39,7 @@ The tutorials fall into a few broad categories. Some examples in each category a
 
 * Bluetooth Low Energy
     * [Running the example BLE app included in the repo](bletiny_project.md)
+    * [Working with another example BLE app for a peripheral device](bleprph/bleprph-intro.md)
 
 <br>
 

http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/0d7a246e/mkdocs.yml
----------------------------------------------------------------------
diff --git a/mkdocs.yml b/mkdocs.yml
index e361cdf..663f91f 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -314,7 +314,7 @@ pages:
                 - 'json_encode_object_key': 'os/modules/json/json_encode_object_key.md'
                 - 'json_encode_object_start': 'os/modules/json/json_encode_object_start.md'
                 - 'json_read_object': 'os/modules/json/json_read_object.md'
-	- Flash Circular Buffer:
+        - Flash Circular Buffer:
             - toc: 'os/modules/fcb/fcb.md'
             - 'Functions':
                 - 'fcb_init': 'os/modules/fcb/fcb_init.md'