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/02/20 03:52:10 UTC
[7/9] incubator-mynewt-site git commit: added pages for the Core OS
functions
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/console/console_pull_char.md
----------------------------------------------------------------------
diff --git a/docs/modules/console/console_pull_char.md b/docs/modules/console/console_pull_char.md
deleted file mode 100644
index 7f06172..0000000
--- a/docs/modules/console/console_pull_char.md
+++ /dev/null
@@ -1,47 +0,0 @@
-## <font color="#F2853F" style="font-size:24pt"> console_pull_char </font>
-
-```no-highlight
- static uint8_t
- console_pull_char(struct console_ring *cr)
-```
-
-Reads (remove) a byte from the console ring buffer. When you read (pull) an item, you read it at the current tail location, and the tail advances to the next position.
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| *cr | Pointer to the console ring buffer from where a character is to be removed |
-
-
-#### Returned values
-
-Returns the character pulled from the ring buffer.
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-Read the characters in the ring buffer into a string.
-
-```no-highlight
-void
-task(struct console_ring *cr, char *str, int cnt)
-{
- for (i = 0; i < cnt; i++) {
- if (cr->cr_head == cr->cr_tail) {
- i = -1;
- break;
- }
- ch = console_pull_char(cr);
- *str++ = ch;
- }
-}
-```
-
-
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/console/console_pull_char_head.md
----------------------------------------------------------------------
diff --git a/docs/modules/console/console_pull_char_head.md b/docs/modules/console/console_pull_char_head.md
deleted file mode 100644
index c266e41..0000000
--- a/docs/modules/console/console_pull_char_head.md
+++ /dev/null
@@ -1,57 +0,0 @@
-## <font color="#F2853F" style="font-size:24pt"> console_pull_char_head </font>
-
-```no-highlight
- static void
- console_pull_char_head(struct console_ring *cr)
-```
-
-Removes the last character inserted into the ring buffer by moving back the head location and shrinking the ring size by 1.
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| cr | Pointer to the console ring buffer from which the last inserted character must be deleted |
-
-
-#### Returned values
-
-None
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-In order to see a character getting deleted when a user hits backspace while typying a command, the following needs to happen in sequence:
-
-* output a backspace (move cursor back one character)
-* output space (erasing whatever character there was before)
-* output backspace (move cursor back one character)
-* remove the previous character from incoming RX queue
-
-The example below shows console_pull_char_head being used for the last step.
-
-```no-highlight
-void
-task(uint8_t data)
-{
- struct console_tty *ct = (struct console_tty *)arg;
- struct console_ring *tx = &ct->ct_tx;
- struct console_ring *rx = &ct->ct_rx;
-
- switch (data) {
- case '\b':
- console_add_char(tx, '\b');
- console_add_char(tx, ' ');
- console_add_char(tx, '\b');
- console_pull_char_head(rx);
- break;
- }
-}
-
-```
-
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/console/console_queue_char.md
----------------------------------------------------------------------
diff --git a/docs/modules/console/console_queue_char.md b/docs/modules/console/console_queue_char.md
deleted file mode 100644
index 74e34f3..0000000
--- a/docs/modules/console/console_queue_char.md
+++ /dev/null
@@ -1,33 +0,0 @@
-## <font color="#F2853F" style="font-size:24pt"> console_queue_char </font>
-
-```no-highlight
- static void
- console_queue_char(char ch)
-```
-
-Manage the buffer queue before inserting a character into it. If the head of the output (transmit) console ring is right up to its tail, the queue needs to be drained first before any data can be added. Then it uses console_add_char function to add the character.
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| ch | Character to be inserted to the queue |
-
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Function blocks interrupts as a way of protecting against concurrent access to TX buffer.
-
-If TX buffer is full, the function waits for TX buffer to drain. And the way it does it currently is by calling os_time_delay(). Therefore this function should only be called from within a task context, not from an interrupt handler. We might want to change this...
-
-#### Example
-
-```no-highlight
-Insert example
-```
-
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/console/console_read.md
----------------------------------------------------------------------
diff --git a/docs/modules/console/console_read.md b/docs/modules/console/console_read.md
deleted file mode 100644
index 9c7460f..0000000
--- a/docs/modules/console/console_read.md
+++ /dev/null
@@ -1,31 +0,0 @@
-i## <font color="#F2853F" style="font-size:24pt"> console_read </font>
-
-```no-highlight
- int
- console_read(char *str, int cnt)
-```
- Calls hal function hal_uart_start_rx to start receiving input from console terminal over serial port.
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-Give at least one example of usage.
-
-
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/console/console_rx_char.md
----------------------------------------------------------------------
diff --git a/docs/modules/console/console_rx_char.md b/docs/modules/console/console_rx_char.md
deleted file mode 100644
index bb3c338..0000000
--- a/docs/modules/console/console_rx_char.md
+++ /dev/null
@@ -1,30 +0,0 @@
-## <font color="#F2853F" style="font-size:24pt"> console_rx_char </font>
-
-```no-highlight
- static int
- console_rx_char(void *arg, uint8_t data)
-```
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-Give at least one example of usage.
-
-
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/console/console_tx_char.md
----------------------------------------------------------------------
diff --git a/docs/modules/console/console_tx_char.md b/docs/modules/console/console_tx_char.md
deleted file mode 100644
index d3f0dec..0000000
--- a/docs/modules/console/console_tx_char.md
+++ /dev/null
@@ -1,30 +0,0 @@
-## <font color="#F2853F" style="font-size:24pt"> console_tx_char </font>
-
-```no-highlight
- static int
- console_tx_char(void *arg)
-```
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-Give at least one example of usage.
-
-
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/console/console_write.md
----------------------------------------------------------------------
diff --git a/docs/modules/console/console_write.md b/docs/modules/console/console_write.md
deleted file mode 100644
index 1d7a524..0000000
--- a/docs/modules/console/console_write.md
+++ /dev/null
@@ -1,46 +0,0 @@
-## <font color="#F2853F" style="font-size:24pt"> console_write </font>
-
-```no-highlight
- void
- console_write(char *str, int cnt)
-```
-Transmit characters to console display over serial port.
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| *str | pointer to the character or packet to be transmitted |
-| cnt | size of the character or packet |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-Here is an example of the function being used in an echo command with a newline at the end.
-
-```no-highlight
-static int
-shell_echo_cmd(int argc, char **argv)
-{
- int i;
-
- for (i = 1; i < argc; i++) {
- console_write(argv[i], strlen(argv[i]));
- console_write(" ", sizeof(" ")-1);
- }
- console_write("\n", sizeof("\n")-1);
-
- return (0);
-}
-```
-
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/elua.md
----------------------------------------------------------------------
diff --git a/docs/modules/elua.md b/docs/modules/elua.md
deleted file mode 100644
index d49d9bb..0000000
--- a/docs/modules/elua.md
+++ /dev/null
@@ -1,17 +0,0 @@
-# elua
-
-Insert synopsis here
-
-
-## Description
-
-Describe module here, special features, how pieces fit together etc.
-
-## Data structures
-
-Replace this with the list of data structures used, why, any neat features
-
-## List of Functions
-
-<Comments such as these instructions are placed within angle brackets. List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the header has to have at least 2 words for the anchor to work - that's how it is. "no-highlight" disables syntax highlighting. You can enable it for a particular language by specifying what the language is instead of "no-highlight". Be warned that this highlighting or no-highlighting specification may not show up nicely on Mou.>
-
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/filesystem.md
----------------------------------------------------------------------
diff --git a/docs/modules/filesystem.md b/docs/modules/filesystem.md
deleted file mode 100644
index 6f40d4c..0000000
--- a/docs/modules/filesystem.md
+++ /dev/null
@@ -1,750 +0,0 @@
-# Filesystem
-
-Mynewt provides a Flash File System abstraction layer (fs) to allow you to swap out the default Newtron File System (nffs) with a different file system of your choice.
-
-## Description
-
-The default file system used in the Mynewt OS is the Newtron Flash File System (nffs). Hence the `nffs` egg description lists `libs/fs` as a dependency.
-
-```no-highlight
-egg.name: libs/nffs
-egg.vers: 0.1
-egg.identities: NFFS
-egg.deps:
- - libs/os
- - libs/fs
- - libs/testutil
- - hw/hal
-```
-
-If the user wishes to use a different flash file system (say, "ownffs"), the directory containing "ownffs" code must include the `egg.yml` file stating the dependency on `libs/fs` listed as shown above. "ownffs" uses the `libs/fs` API available in mynewt, thus minimizing changes to other parts of the project.
-
-Note that this generic file system (`fs`) API does not expose any file system detection, initialization, and formatting functions. These function calls remain specific to the chosen file system. For example, Project Slinky uses the default Newtron File System (nffs) and therefore calls nffs_init() to initialize the nffs memory and data structures before any other file system operations are attempted. As shown below, the egg for Project Slinky includes the `libs/imgmgr` egg which in turn includes the `libs/bootutil ` egg. The egg description for `libs/bootutil` specifies `fs/nffs` as a dependency.
-
-```no-highlight
-
- egg.name: project/slinky
- egg.vers: 0.1
- egg.deps:
- - libs/os
- - libs/console/full
- - libs/shell
- - libs/newtmgr
- - libs/imgmgr
- - sys/config
- - sys/log
- - sys/stats
-```
-
-```no-highlight
-
- egg.name: libs/imgmgr
- egg.vers: 0.1
- egg.deps:
- - libs/newtmgr
- - libs/bootutil
- egg.deps.FS:
- - fs/fs
- egg.cflags.FS: -DFS_PRESENT
-```
-
-```no-highlight
-
- egg.name: libs/bootutil
- egg.vers: 0.1
- egg.deps:
- - fs/nffs
- - libs/os
- - libs/testutil
- - hw/hal
-```
-
-## Data Structures
-
-
-## API
-
-```no-highlight
- struct fs_file;
-```
-
-The functions available in this OS feature are:
-
-* [fs_open](#fs_open)
-* [fs_close](#fs_close)
-* [fs_read](#fs_read)
-* [fs_write](#fs_write)
-* [fs_seek](#fs_seek)
-* [fs_getpos](#fs_getpos)
-* [fs_filelen](#fs_filelen)
-* [fs_unlink](#fs_unlink)
-* [fs_rename](#fs_rename)
-* [fs_mkdir](#fs_mkdir)
-* [fs_opendir](#fs_opendir)
-* [fs_readdir](#fs_readdir)
-* [fs_closedir](#fs_closedir)
-* [fs_dirent_name](#fs_dirent_name)
-* [fs_dirent_is_dir](#fs_dirent_is_dir)
-
-Additional file system utilities that bundle some of the basic functions above are:
-
-* [fsutil_read_file](#fsutil_read_file)
-* [fsutil_write_file](#fsutil_write_file)
-
-
-## API Reference
-
-------------------
-
-## <font color="F2853F" style="font-size:24pt"> fs_open </font>
-
-```no-highlight
- int
- fs_open(const char *filename, uint8_t access_flags, struct fs_file **out_file);
-```
-
-Opens a file at the specified path. The result of opening a nonexistent file depends on the access flags specified. All intermediate directories must already exist.
-
-The mode strings passed to fopen() map to fs_open()'s access flags as follows:
-
-```no-highlight
- "r" - FS_ACCESS_READ
- "r+" - FS_ACCESS_READ | FS_ACCESS_WRITE
- "w" - FS_ACCESS_WRITE | FS_ACCESS_TRUNCATE
- "w+" - FS_ACCESS_READ | FS_ACCESS_WRITE | FS_ACCESS_TRUNCATE
- "a" - FS_ACCESS_WRITE | FS_ACCESS_APPEND
- "a+" - FS_ACCESS_READ | FS_ACCESS_WRITE | FS_ACCESS_APPEND
-```
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| filename | Pointer to the file created at the path of the specified filename |
-| access_flags | Flags controlling file access; see above table |
-| out_file | On success, a pointer to the newly-created file handle gets written here|
-
-#### Returned values
-
-* 0 on success
-* nonzero on failure
-
-#### Notes
-
-There is no concept of current working directory. Therefore all file names should start with '/'.
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```no-highlight
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-## <font color="#F2853F" style="font-size:24pt"> fs_close </font>
-
-```no-highlight
- int
- fs_close(struct fs_file *file)
-```
-
-Closes the specified file and invalidates the file handle. If the file has already been unlinked, and this is the last open handle to the file, this operation causes the file to be deleted from disk.
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| file | Pointer to the file to close |
-
-#### Returned values
-
-* 0 on success
-* nonzero on failure
-
-#### Notes
-
-Don't use file handle after closing the file.
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```no-highlight
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-## <font color="#F2853F" style="font-size:24pt"> fs_read </font>
-
-```no-highlight
- int
- fs_read(struct fs_file *file, uint32_t len, void *out_data, uint32_t *out_len);
-```
-
-Reads data from the specified file. If more data is requested than remains in the file, all available data is retrieved. Function returns in `out_len` the actual number of bytes read (less or equal to `len`).
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| file | Pointer to the the file to read from |
-| len | The number of bytes to attempt to read |
-| out_data | The destination buffer to read into
-| out_len | On success, the number of bytes actually read gets written here. Pass null if you don't care. |
-
-#### Returned values
-
-* 0 on success
-* nonzero on failure
-
-#### Notes
-
-This type of short read results in a success return code.
-
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```no-highlight
-<Insert the code snippet here>
-
-```
-
----------------------
-
-## <font color="#F2853F" style="font-size:24pt"> fs_write </font>
-
-```no-highlight
- int
- fs_write(struct fs_file *file, const void *data, int len);
-```
-
-Writes the supplied data to the current offset of the specified file handle.
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| file | Pointer to the file to write to |
-| data | The data to write |
-| len | The number of bytes to write |
-
-
-#### Returned values
-
-* 0 on success
-* nonzero on failure
-
-#### Notes
-
-<any notes?>
-
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```no-highlight
-<Insert the code snippet here>
-```
-
----------------------
-
-## <font color="#F2853F" style="font-size:24pt"> fs_seek </font>
-
-```no-highlight
- int
- fs_seek(struct fs_file *file, uint32_t offset);
-```
-
-Positions a file's read and write pointer at the specified offset. The offset is expressed as the number of bytes from the start of the file (i.e., seeking to offset 0 places the pointer at the first byte in the file).
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| file | Pointer to the file to reposition |
-| offset | The 0-based file offset to seek to |
-
-
-#### Returned values
-
-* 0 on success
-* nonzero on failure
-
-#### Notes
-
-<any notes?>
-
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```no-highlight
-<Insert the code snippet here>
-```
-
----------------------
-
-## <font color="#F2853F" style="font-size:24pt"> fs_getpos </font>
-
-```no-highlight
- uint32_t
- fs_getpos(const struct fs_file *file);
-```
-
-Retrieves the current read and write position of the specified open file.
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| file | Pointer to the file to query |
-
-
-#### Returned values
-
-* The file offset, in bytes
-
-#### Notes
-
-<any notes?>
-
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```no-highlight
-<Insert the code snippet here>
-```
-
----------------------
-
-## <font color="#F2853F" style="font-size:24pt"> fs_filelen </font>
-
-```no-highlight
- int
- fs_filelen(const struct fs_file *file, uint32_t *out_len);
-
-```
-
-Retrieves the current length of the specified open file.
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| file | Pointer to the file to query |
-| out_len | On success, the number of bytes in the file gets written here |
-
-
-#### Returned values
-
-* 0 on success
-* nonzero on failure
-
-#### Notes
-
-<any notes?>
-
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```no-highlight
-<Insert the code snippet here>
-```
-
----------------------
-
-## <font color="#F2853F" style="font-size:24pt"> fs_unlink </font>
-
-```no-highlight
- int
- fs_unlink(const char *filename);
-
-```
-
-Unlinks the file or directory at the specified path. 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.
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| filename | The path of the file or directory to unlink |
-
-
-#### Returned values
-
-* 0 on success
-* nonzero on failure
-
-#### Notes
-
-<any notes?>
-
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```no-highlight
-<Insert the code snippet here>
-```
-
----------------------
-
-## <font color="#F2853F" style="font-size:24pt"> fs_rename </font>
-
-```no-highlight
- int
- fs_rename(const char *from, const char *to);
-
-```
-
-Performs a rename and / or move of the specified source path to the specified destination.
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| from | The source path |
-| to | The destination path |
-
-
-#### Returned values
-
-* 0 on success
-* nonzero on failure
-
-#### Notes
-
-The source path can refer to either a file or a directory. All intermediate directories in the destination path must already exist. If the source path refers to a file, the destination path must contain a full filename path, rather than just the new parent directory. If an object already exists at the specified destination path, this function causes it to be unlinked prior to the rename (i.e., the destination gets clobbered).
-
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```no-highlight
-<Insert the code snippet here>
-```
-
----------------------
-
-## <font color="#F2853F" style="font-size:24pt"> fs_mkdir </font>
-
-```no-highlight
- int
- fs_mkdir(const char *path);
-
-```
-
-Creates the directory represented by the specified path.
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| path | Pointer to the directory to create |
-
-
-#### Returned values
-
-* 0 on success
-* nonzero on failure.
-
-#### Notes
-
-All intermediate directories must already exist. The specified path must start with a '/' character.
-
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```no-highlight
-<Insert the code snippet here>
-```
-
----------------------
-
-## <font color="#F2853F" style="font-size:24pt"> fs_opendir </font>
-
-```no-highlight
-
- int
- fs_opendir(const char *path, struct fs_dir **out_dir);
-
-```
-
-Opens the directory at the specified path. The directory's contents can be read with subsequent calls to fs_readdir(). When you are done with the directory handle, close it with fs_closedir().
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| path | Pointer to the directory to create |
-| out_dir | On success, points to the directory handle |
-
-
-#### Returned values
-
-* 0 on success
-* FS_ENOENT if the specified directory does not exist (no such file)
-* Other nonzero on error.
-
-#### Notes
-
-Unlinking files from the directory while it is open may result in unpredictable behavior. New files can be created inside the directory.
-
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```no-highlight
-<Insert the code snippet here>
-```
-
----------------------
-
-## <font color="#F2853F" style="font-size:24pt"> fs_readdir </font>
-
-```no-highlight
- int
- fs_readdir(struct fs_dir *dir, struct fs_dirent **out_dirent);
-
-```
-
-Reads the next entry in an open directory.
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| dir | The directory handle to read from |
-| out_dirent | On success, points to the next child entry in the specified directory |
-
-
-#### Returned values
-
-* 0 on success
-* FS_ENOENT if there are no more entries in the parent directory
-* Other nonzero on error.
-
-#### Notes
-
-<any notes?>
-
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```no-highlight
-<Insert the code snippet here>
-```
-
----------------------
-
-## <font color="#F2853F" style="font-size:24pt"> fs_closedir </font>
-
-```no-highlight
- int
- fs_closedir(struct fs_dir *dir);
-
-```
-
-Closes the specified directory handle.
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| dir | Pointer to the directory to close |
-
-
-#### Returned values
-
-* 0 on success
-* nonzero on failure
-
-#### Notes
-
-<any notes?>
-
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```no-highlight
-<Insert the code snippet here>
-```
-
----------------------
-
-## <font color="#F2853F" style="font-size:24pt"> fs_dirent_name </font>
-
-```no-highlight
- int
- fs_dirent_name(const struct fs_dirent *dirent, size_t max_len,
- char *out_name, uint8_t *out_name_len);
-
-```
-
-Retrieves the filename of the specified directory entry.
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| dirent | Pointer to the directory entry to query |
-| max_len | Size of the "out_name" character buffer |
-| out_name | On success, the entry's filename is written here; always null-terminated |
-| out_name_len | On success, contains the actual length of the filename, NOT including the null-terminator |
-
-
-#### Returned values
-
-* 0 on success
-* nonzero on failure
-
-#### Notes
-
-The retrieved filename is always null-terminated. To ensure enough space to hold the full filename plus a null-termintor, a destination buffer of size (filename max length + 1) should be used.
-
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```no-highlight
-<Insert the code snippet here>
-```
-
----------------------
-
-## <font color="#F2853F" style="font-size:24pt"> fs_dirent_is_dir </font>
-
-```no-highlight
- int
- fs_dirent_is_dir(const struct fs_dirent *dirent);
-
-```
-
-Tells you whether the specified directory entry is a sub-directory or a regular file.
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| dirent | Pointer to the directory entry to query |
-
-
-#### Returned values
-
-* 1: The entry is a directory
-* 0: The entry is a regular file.
-
-#### Notes
-
-<any notes?>
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```no-highlight
-<Insert the code snippet here>
-```
-
----------------------
-
-## <font color="#F2853F" style="font-size:24pt"> fsutil_read_file </font>
-
-```no-highlight
- int
- fsutil_read_file(const char *path, uint32_t offset, uint32_t len, void *dst,
- uint32_t *out_len);
-```
-
-Calls fs_open(), fs_read(), and fs_close() to open a file at the specified path, retrieve data from the file starting from the specified offset, and close the file and invalidate the file handle.
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| path | Pointer to the directory entry to query |
-| offset | Position of the file's read pointer |
-| len | Number of bytes to attempt to read |
-| dst | Destination buffer to read into |
-| out_len | On success, the number of bytes actually read gets written here. Pass null if you don't care. |
-
-#### Returned values
-
-* 0 on success
-* nonzero on failure
-
-#### Notes
-
-This is a convenience function. You can use it if the file is small (caller has enough buffer space to hold all the file contents in memory).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```no-highlight
-<Insert the code snippet here>
-```
-
----------------------
-
-## <font color="#F2853F" style="font-size:24pt"> fsutil_write_file </font>
-
-```no-highlight
- int
- fsutil_write_file(const char *path, const void *data, uint32_t len);
-```
-
-Calls fs_open(), fs_write(), and fs_close() to open a file at the specified path, write the supplied data to the current offset of the specified file handle, and close the file and invalidate the file handle.
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| path | Pointer to the file to write to |
-| data | The data to write |
-| len | The number of bytes to write |
-
-#### Returned values
-
-* 0 on success
-* nonzero on failure
-
-#### Notes
-
-<any notes?>
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```no-highlight
-<Insert the code snippet here>
-```
-
----------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/imgmgr/imgmgr.md
----------------------------------------------------------------------
diff --git a/docs/modules/imgmgr/imgmgr.md b/docs/modules/imgmgr/imgmgr.md
deleted file mode 100644
index 650314b..0000000
--- a/docs/modules/imgmgr/imgmgr.md
+++ /dev/null
@@ -1,35 +0,0 @@
-# Image Manager
-
-Insert synopsis here
-
-
-## Description
-
-Describe module here, special features, how pieces fit together etc.
-
-## Data structures
-
-Replace this with the list of data structures used, why, any neat features
-
-## List of Functions
-
-<Comments such as these instructions are placed within angle brackets. List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the header has to have at least 2 words for the anchor to work - that's how it is. "no-highlight" disables syntax highlighting. You can enable it for a particular language by specifying what the language is instead of "no-highlight". Be warned that this highlighting or no-highlighting specification may not show up nicely on Mou.>
-
-The functions available in imgmgr are:
-
-* [imgmgr_module_init](imgmgr_module_init.md)
-* [imgr_boot_read](imgr_boot_read.md)
-* [imgr_boot_write](imgr_boot_write.md)
-* [imgr_file_download](imgr_file_download.md)
-* [imgr_file_upload](imgr_file_upload.md)
-* [imgr_list](imgr_list.md)
-* [imgr_noop](imgr_noop.md)
-* [imgr_read_file](imgr_read_file.md)
-* [imgr_read_main](imgr_read_main.md)
-* [imgr_read_test](imgr_read_test.md)
-* [imgr_read_ver](imgr_read_ver.md)
-* [imgr_upload](imgr_upload.md)
-* [imgr_ver_jsonstr](imgr_ver_jsonstr.md)
-* [imgr_ver_parse](imgr_ver_parse.md)
-* [imgr_ver_str](imgr_ver_str.md)
-* [imgr_write_file](imgr_write_file.md)
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/imgmgr/imgmgr_module_init.md
----------------------------------------------------------------------
diff --git a/docs/modules/imgmgr/imgmgr_module_init.md b/docs/modules/imgmgr/imgmgr_module_init.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/imgmgr/imgr_boot_read.md
----------------------------------------------------------------------
diff --git a/docs/modules/imgmgr/imgr_boot_read.md b/docs/modules/imgmgr/imgr_boot_read.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/imgmgr/imgr_boot_write.md
----------------------------------------------------------------------
diff --git a/docs/modules/imgmgr/imgr_boot_write.md b/docs/modules/imgmgr/imgr_boot_write.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/imgmgr/imgr_file_download.md
----------------------------------------------------------------------
diff --git a/docs/modules/imgmgr/imgr_file_download.md b/docs/modules/imgmgr/imgr_file_download.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/imgmgr/imgr_file_upload.md
----------------------------------------------------------------------
diff --git a/docs/modules/imgmgr/imgr_file_upload.md b/docs/modules/imgmgr/imgr_file_upload.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/imgmgr/imgr_list.md
----------------------------------------------------------------------
diff --git a/docs/modules/imgmgr/imgr_list.md b/docs/modules/imgmgr/imgr_list.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/imgmgr/imgr_noop.md
----------------------------------------------------------------------
diff --git a/docs/modules/imgmgr/imgr_noop.md b/docs/modules/imgmgr/imgr_noop.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/imgmgr/imgr_read_file.md
----------------------------------------------------------------------
diff --git a/docs/modules/imgmgr/imgr_read_file.md b/docs/modules/imgmgr/imgr_read_file.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/imgmgr/imgr_read_main.md
----------------------------------------------------------------------
diff --git a/docs/modules/imgmgr/imgr_read_main.md b/docs/modules/imgmgr/imgr_read_main.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/imgmgr/imgr_read_test.md
----------------------------------------------------------------------
diff --git a/docs/modules/imgmgr/imgr_read_test.md b/docs/modules/imgmgr/imgr_read_test.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/imgmgr/imgr_read_ver.md
----------------------------------------------------------------------
diff --git a/docs/modules/imgmgr/imgr_read_ver.md b/docs/modules/imgmgr/imgr_read_ver.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/imgmgr/imgr_upload.md
----------------------------------------------------------------------
diff --git a/docs/modules/imgmgr/imgr_upload.md b/docs/modules/imgmgr/imgr_upload.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/imgmgr/imgr_ver_jsonstr.md
----------------------------------------------------------------------
diff --git a/docs/modules/imgmgr/imgr_ver_jsonstr.md b/docs/modules/imgmgr/imgr_ver_jsonstr.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/imgmgr/imgr_ver_parse.md
----------------------------------------------------------------------
diff --git a/docs/modules/imgmgr/imgr_ver_parse.md b/docs/modules/imgmgr/imgr_ver_parse.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/imgmgr/imgr_ver_str.md
----------------------------------------------------------------------
diff --git a/docs/modules/imgmgr/imgr_ver_str.md b/docs/modules/imgmgr/imgr_ver_str.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/imgmgr/imgr_write_file.md
----------------------------------------------------------------------
diff --git a/docs/modules/imgmgr/imgr_write_file.md b/docs/modules/imgmgr/imgr_write_file.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/json/json.md
----------------------------------------------------------------------
diff --git a/docs/modules/json/json.md b/docs/modules/json/json.md
deleted file mode 100644
index 4e1f920..0000000
--- a/docs/modules/json/json.md
+++ /dev/null
@@ -1,28 +0,0 @@
-# JSON
-
-Insert synopsis here
-
-
-## Description
-
-Describe module here, special features, how pieces fit together etc.
-
-## Data structures
-
-Replace this with the list of data structures used, why, any neat features
-
-## List of Functions
-
-<Comments such as these instructions are placed within angle brackets. List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the header has to have at least 2 words for the anchor to work - that's how it is. "no-highlight" disables syntax highlighting. You can enable it for a particular language by specifying what the language is instead of "no-highlight". Be warned that this highlighting or no-highlighting specification may not show up nicely on Mou.>
-
-The functions available in json are:
-
-* [json_encode_object_entry](json_encode_object_entry.md)
-* [json_encode_object_finish](json_encode_object_finish.md)
-* [json_encode_object_key](json_encode_object_key.md)
-* [json_encode_object_start](json_encode_object_start.md)
-* [json_encode_value](json_encode_value.md)
-* [json_internal_read_object](json_internal_read_object.md)
-* [json_read_array](json_read_array.md)
-* [json_read_object](json_read_object.md)
-* [json_target_address](json_target_address.md)
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/json/json_encode_object_entry.md
----------------------------------------------------------------------
diff --git a/docs/modules/json/json_encode_object_entry.md b/docs/modules/json/json_encode_object_entry.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/json/json_encode_object_finish.md
----------------------------------------------------------------------
diff --git a/docs/modules/json/json_encode_object_finish.md b/docs/modules/json/json_encode_object_finish.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/json/json_encode_object_key.md
----------------------------------------------------------------------
diff --git a/docs/modules/json/json_encode_object_key.md b/docs/modules/json/json_encode_object_key.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/json/json_encode_object_start.md
----------------------------------------------------------------------
diff --git a/docs/modules/json/json_encode_object_start.md b/docs/modules/json/json_encode_object_start.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/json/json_encode_value.md
----------------------------------------------------------------------
diff --git a/docs/modules/json/json_encode_value.md b/docs/modules/json/json_encode_value.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/json/json_internal_read_object.md
----------------------------------------------------------------------
diff --git a/docs/modules/json/json_internal_read_object.md b/docs/modules/json/json_internal_read_object.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/json/json_read_array.md
----------------------------------------------------------------------
diff --git a/docs/modules/json/json_read_array.md b/docs/modules/json/json_read_array.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/json/json_read_object.md
----------------------------------------------------------------------
diff --git a/docs/modules/json/json_read_object.md b/docs/modules/json/json_read_object.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/json/json_target_address.md
----------------------------------------------------------------------
diff --git a/docs/modules/json/json_target_address.md b/docs/modules/json/json_target_address.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/newtmgr.md
----------------------------------------------------------------------
diff --git a/docs/modules/newtmgr.md b/docs/modules/newtmgr.md
deleted file mode 100644
index a17a2c5..0000000
--- a/docs/modules/newtmgr.md
+++ /dev/null
@@ -1,139 +0,0 @@
-# Bootloader
-
-Insert synopsis here
-
-
-## Description
-
-Describe module here, special features, how pieces fit together etc.
-
-## Data structures
-
-Replace this with the list of data structures used, why, any neat features
-
-## List of Functions
-
-<Comments such as these instructions are placed within angle brackets. List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the header has to have at least 2 words for the anchor to work - that's how it is. "no-highlight" disables syntax highlighting. You can enable it for a particular language by specifying what the language is instead of "no-highlight". Be warned that this highlighting or no-highlighting specification may not show up nicely on Mou.>
-
-The functions available in this OS feature are:
-
-* [boot_slot_addr](#boot_slot_addr)
-* [boot_find_image_slot](#boot_find_image_slot)
-* add the rest
-
-
-## Function Reference
-
-------------------
-
-## <font color="F2853F" style="font-size:24pt"> boot_slot_addr </font>
-
-```no-highlight
- static void
- boot_slot_addr(int slot_num, uint8_t *flash_id, uint32_t *address)
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```no-highlight
-<Insert the code snippet here>
-```
-
----------------------
-
-## <font color="#F2853F" style="font-size:24pt"> boot_find_image_slot </font>
-
-```no-highlight
- <Insert function callout here >
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```no-highlight
-<Insert the code snippet here>
-```
-
----------------------
-
-## <font color="#F2853F" style="font-size:24pt"> next_one </font>
-
-```no-highlight
- <Insert function callout here >
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```no-highlight
-<Insert the code snippet here>
-```
-
----------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/nffs.md
----------------------------------------------------------------------
diff --git a/docs/modules/nffs.md b/docs/modules/nffs.md
deleted file mode 100644
index 97ff43d..0000000
--- a/docs/modules/nffs.md
+++ /dev/null
@@ -1,564 +0,0 @@
-# Newtron Flash Filesystem (nffs)
-
-Mynewt comes with the flash file system called the Newtron Flash File System (nffs) which is designed with two priorities that makes it suitable for embedded use:
-
-* Minimal RAM usage
-* Reliability
-
-Mynewt also provides an abstraction layer API (fs) to allow you to swap out nffs with a different file system of your choice.
-
-## Description
-
-Describe module here, special features, how pieces fit together etc.
-
-## Disk and data structures
-
-At the top level, an nffs disk is partitioned into areas. An area is a region
-of disk with the following properties:
-
-1. An area can be fully erased without affecting any other areas.
-2. A write to one area does not restrict writes to other areas.
-
- **Note**: Some flash hardware divides its memory space into "blocks." Writes within a block must be sequential, but writes to one block have no effect on what parts of other blocks can be written. Thus, for flash hardware with such a restriction, each area must comprise a discrete number of blocks.
-
-While not strictly necessary, it is recommended that all areas have the same
-size.
-
-On disk, each area is prefixed with the following header:
-
-```no-highlight
-/** On-disk representation of an area header. */
-struct nffs_disk_area {
- uint32_t nda_magic[4]; /* NFFS_AREA_MAGIC{0,1,2,3} */
- uint32_t nda_length; /* Total size of area, in bytes. */
- uint8_t nda_ver; /* Current nffs version: 0 */
- uint8_t nda_gc_seq; /* Garbage collection count. */
- uint8_t reserved8;
- uint8_t nda_id; /* 0xff if scratch area. */
-};
-```
-
-Beyond its header, an area contains a sequence of disk objects, representing
-the contents of the file system. There are two types of objects: **inodes** and
-**data blocks**. An inode represents a file or directory; a data block represents
-part of a file's contents.
-
-```no-highlight
-/** On-disk representation of an inode (file or directory). */
-struct nffs_disk_inode {
- uint32_t ndi_magic; /* NFFS_INODE_MAGIC */
- uint32_t ndi_id; /* Unique object ID. */
- uint32_t ndi_seq; /* Sequence number; greater supersedes
- lesser. */
- uint32_t ndi_parent_id; /* Object ID of parent directory inode. */
- uint8_t reserved8;
- uint8_t ndi_filename_len; /* Length of filename, in bytes. */
- uint16_t ndi_crc16; /* Covers rest of header and filename. */
- /* Followed by filename. */
-};
-```
-
-An inode filename's length cannot exceed 256 bytes. The filename is not
-null-terminated. The following ASCII characters are not allowed in a
-filename:
- * / (slash character)
- * \0 (NUL character)
-
-```no-highlight
-/** On-disk representation of a data block. */
-struct nffs_disk_block {
- uint32_t ndb_magic; /* NFFS_BLOCK_MAGIC */
- uint32_t ndb_id; /* Unique object ID. */
- uint32_t ndb_seq; /* Sequence number; greater supersedes lesser. */
- uint32_t ndb_inode_id; /* Object ID of owning inode. */
- uint32_t ndb_prev_id; /* Object ID of previous block in file;
- NFFS_ID_NONE if this is the first block. */
- uint16_t ndb_data_len; /* Length of data contents, in bytes. */
- uint16_t ndb_crc16; /* Covers rest of header and data. */
- /* Followed by 'ndb_data_len' bytes of data. */
-};
-```
-
-Each data block contains the ID of the previous data block in the file.
-Together, the set of blocks in a file form a reverse singly-linked list.
-
-The maximum number of data bytes that a block can contain is determined at
-initialization-time. The result is the greatest number which satisfies all of
-the following restrictions:
- o No more than 2048.
- o At least two maximum-sized blocks can fit in the smallest area.
-
-The 2048 number was chosen somewhat arbitrarily, and may change in the future.
-
-### ID space
-
-All disk objects have a unique 32-bit ID. The ID space is partitioned as
-follows:
- * 0x00000000 - 0x0fffffff: Directory inodes.
- * 0x10000000 - 0x7fffffff: File inodes.
- * 0x80000000 - 0xfffffffe: Data blocks.
- * 0xffffffff : Reserved (NFFS_ID_NONE)
-
-### Scratch area
-
-A valid nffs file system must contain a single "scratch area." The scratch
-area does not contain any objects of its own, and is only used during garbage
-collection. The scratch area must have a size greater than or equal to each
-of the other areas in flash.
-
-
-### RAM representation
-
-Every object in the file system is stored in a 256-entry hash table. An
-object's hash key is derived from its 32-bit ID. Each list in the hash table
-is sorted by time of use; most-recently-used is at the front of the list. All
-objects are represented by the following structure:
-
-```no-highlight
-/**
- * What gets stored in the hash table. Each entry represents a data block or
- * an inode.
- */
-struct nffs_hash_entry {
- SLIST_ENTRY(nffs_hash_entry) nhe_next;
- uint32_t nhe_id; /* 0 - 0x7fffffff if inode; else if block. */
- uint32_t nhe_flash_loc; /* Upper-byte = area idx; rest = area offset. */
-};
-```
-
-For each data block, the above structure is all that is stored in RAM. To
-acquire more information about a data block, the block header must be read
-from flash.
-
-Inodes require a fuller RAM representation to capture the structure of the
-file system. There are two types of inodes: **files** and **directories**. Each
-inode hash entry is actually an instance of the following structure:
-
-```no-highlight
-/** Each inode hash entry is actually one of these. */
-struct nffs_inode_entry {
- struct nffs_hash_entry nie_hash_entry;
- SLIST_ENTRY(nffs_inode_entry) nie_sibling_next;
- union {
- struct nffs_inode_list nie_child_list; /* If directory */
- struct nffs_hash_entry *nie_last_block_entry; /* If file */
- };
- uint8_t nie_refcnt;
-};
-```
-
-A directory inode contains a list of its child files and directories
-(fie_child_list). These entries are sorted alphabetically using the ASCII
-character set.
-
-A file inode contains a pointer to the last data block in the file
-(nie_last_block_entry). For most file operations, the reversed block list must
-be walked backwards. This introduces a number of speed inefficiencies:
- * All data blocks must be read to determine the length of the file.
- * Data blocks often need to be processed sequentially. The reversed
- nature of the block list transforms this from linear time to an O(n^2)
- operation.
-
-Furthermore, obtaining information about any constituent data block requires a
-separate flash read.
-
-### Inode cache and Data Block cache
-
-The speed issues are addressed by a pair of caches. Cached inodes entries
-contain the file length and a much more convenient doubly-linked list of
-cached data blocks. The benefit of using caches is that the size of the
-caches need not be proportional to the size of the file system. In other
-words, caches can address speed efficiency concerns without negatively
-impacting the file system's scalability.
-
-nffs requires both caches during normal operation, so it is not possible to
-disable them. However, the cache sizes are configurable, and both caches can
-be configured with a size of one if RAM usage must be minimized.
-
-The following data structures are used in the inode and data block caches.
-
-```no-highlight
-/** Full data block representation; not stored permanently in RAM. */
-struct nffs_block {
- struct nffs_hash_entry *nb_hash_entry; /* Points to real block entry. */
- uint32_t nb_seq; /* Sequence number; greater
- supersedes lesser. */
- struct nffs_inode_entry *nb_inode_entry; /* Owning inode. */
- struct nffs_hash_entry *nb_prev; /* Previous block in file. */
- uint16_t nb_data_len; /* # of data bytes in block. */
- uint16_t reserved16;
-};
-
-/** Represents a single cached data block. */
-struct nffs_cache_block {
- TAILQ_ENTRY(nffs_cache_block) ncb_link; /* Next / prev cached block. */
- struct nffs_block ncb_block; /* Full data block. */
- uint32_t ncb_file_offset; /* File offset of this block. */
-};
-
-/** Full inode representation; not stored permanently in RAM. */
-struct nffs_inode {
- struct nffs_inode_entry *ni_inode_entry; /* Points to real inode entry. */
- uint32_t ni_seq; /* Sequence number; greater
- supersedes lesser. */
- struct nffs_inode_entry *ni_parent; /* Points to parent directory. */
- uint8_t ni_filename_len; /* # chars in filename. */
- uint8_t ni_filename[NFFS_SHORT_FILENAME_LEN]; /* First 3 bytes. */
-};
-
-/** Doubly-linked tail queue of cached blocks; contained in cached inodes. */
-TAILQ_HEAD(nffs_block_cache_list, nffs_block_cache_entry);
-
-/** Represents a single cached file inode. */
-struct nffs_cache_inode {
- TAILQ_ENTRY(nffs_cache_inode) nci_link; /* Sorted; LRU at tail. */
- struct nffs_inode nci_inode; /* Full inode. */
- struct nffs_cache_block_list nci_block_list; /* List of cached blocks. */
- uint32_t nci_file_size; /* Total file size. */
-};
-```
-
-Only file inodes are cached; directory inodes are never cached.
-
-Within a cached inode, all cached data blocks are contiguous. E.g., if the
-start and end of a file are cached, then the middle must also be cached. A
-data block is only cached if its owning file is also cached.
-
-Internally, cached inodes are stored in a singly-linked list, ordered by time
-of use. The most-recently-used entry is the first element in the list. If a
-new inode needs to be cached, but the inode cache is full, the
-least-recently-used entry is freed to make room for the new one. The
-following operations cause an inode to be cached:
-
-* Querying a file's length.
-* Seeking within a file.
-* Reading from a file.
-* Writing to a file.
-
-The following operations cause a data block to be cached:
-
-* Reading from the block.
-* Writing to the block.
-
-If one of the above operations is applied to a data block that is not currently
-cached, nffs uses the following procedure to cache the necessary block:
-
-1. If none of the owning inode's blocks are currently cached, allocate a
- cached block entry corresponding to the requested block and insert it
- into the inode's list.
-2. Else if the requested file offset is less than that of the first cached
- block, bridge the gap between the inode's sequence of cached blocks and
- the block that now needs to be cached. This is accomplished by caching
- each block in the gap, finishing with the requested block.
-3. Else (the requested offset is beyond the end of the cache),
- a. If the requested offset belongs to the block that immediately follows the end of the cache, cache the block and append it to the list.
- b. Else, clear the cache, and populate it with the single entry corresponding to the requested block.
-
-If the system is unable to allocate a cached block entry at any point during
-the above procedure, the system frees up other blocks currently in the cache. This is accomplished as follows:
-
-* Iterate the inode cache in reverse (i.e., start with the least-recently-used entry). For each entry:
- a. If the entry's cached block list is empty, advance to the next entry.
- b. Else, free all the cached blocks in the entry's list.
-
-Because the system imposes a minimum block cache size of one, the above
-procedure will always reclaim at least one cache block entry. The above
-procedure may result in the freeing of the block list that belongs to the very
-inode being operated on. This is OK, as the final block to get cached is
-always the block being requested.
-
-
-## Configuration
-
-The file system is configured by populating fields in a global structure.
-Each field in the structure corresponds to a setting. All configuration must
-be done prior to calling nffs_init(). The configuration structure is defined
-as follows:
-
-```no-highlight
-
-struct nffs_config {
- /** Maximum number of inodes; default=1024. */
- uint32_t nc_num_inodes;
-
- /** Maximum number of data blocks; default=4096. */
- uint32_t nc_num_blocks;
-
- /** Maximum number of open files; default=4. */
- uint32_t nc_num_files;
-
- /** Inode cache size; default=4. */
- uint32_t nc_num_cache_inodes;
-
- /** Data block cache size; default=64. */
- uint32_t nc_num_cache_blocks;
- };
-
-extern struct nffs_config nffs_config;
-```
-
-Any fields that are set to 0 (or not set at all) inherit the corresponding
-default value. This means that it is impossible to configure any setting with
-a value of zero.
-
-
-## Initialization
-
-There are two means of initializing an nffs file system:
-
-1. Restore an existing file system via detection.
-2. Create a new file system via formatting.
-
-Both methods require the user to describe how the flash memory is divided into
-areas. This is accomplished with an array of struct nffs_area_desc, defined as
-follows:
-
-```no-highlight
-struct nffs_area_desc {
- uint32_t nad_offset; /* Flash offset of start of area. */
- uint32_t nad_length; /* Size of area, in bytes. */
-};
-```
-
-An array of area descriptors is terminated by an entry with a fad_length field
-of 0.
-
-One common initialization sequence is the following:
-
-1. Detect an nffs file system anywhere in flash.
-2. If no file system detected, format a new file system in a specific
- region of flash.
-
-
-## Detection
-
-The file system detection process consists of scanning a specified set of
-flash regions for valid nffs areas, and then populating the RAM representation
-of the file system with the detected objects. Detection is initiated with the
-following function:
-
-```no-highlight
-/**
- * Searches for a valid nffs file system among the specified areas. This
- * function succeeds if a file system is detected among any subset of the
- * supplied areas. If the area set does not contain a valid file system,
- * a new one can be created via a separate call to nffs_format().
- *
- * @param area_descs The area set to search. This array must be
- * terminated with a 0-length area.
- *
- * @return 0 on success;
- * NFFS_ECORRUPT if no valid file system was detected;
- * other nonzero on error.
- */
-int nffs_detect(const struct nffs_area_desc *area_descs);
-```
-As indicated, not every area descriptor needs to reference a valid nffs area.
-Detection is successful as long as a complete file system is detected
-somewhere in the specified regions of flash. If an application is unsure
-where a file system might be located, it can initiate detection across the
-entire flash region.
-
-A detected file system is valid if:
-
-1. At least one non-scratch area is present.
-2. At least one scratch area is present (only the first gets used if there is more than one).
-3. The root directory inode is present.
-
-During detection, each indicated region of flash is checked for a valid area
-header. The contents of each valid non-scratch area are then restored into
-the nffs RAM representation. The following procedure is applied to each object
-in the area:
-
-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.
-
-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.
-
-After all areas have been restored, a sweep is performed across the entire RAM
-representation so that invalid inodes can be deleted from memory.
-
-For each directory inode:
-
-* If its reference count is 0 (i.e., it is a dummy), migrate its children to the /lost+found directory, and delete it from the RAM representation. This should only happen in the case of file system corruption.
- * If its parent reference is null (i.e., it was deleted), delete it and all its children from the RAM representation.
-
-For each file inode:
-
-* If its reference count is 0 (i.e., it is a dummy), delete it from the RAM representation. This should only happen in the case of file system corruption. (We should try to migrate the file to the lost+found directory in this case, as mentioned in the todo section).
-
-When an object is deleted during this sweep, it is only deleted from the RAM
-representation; nothing is written to disk.
-
-When objects are migrated to the lost+found directory, their parent inode
-reference is permanently updated on the disk.
-
-In addition, a single scratch area is identified during the detection process.
-The first area whose 'fda_id' value is set to 0xff is designated as the file
-system scratch area. If no valid scratch area is found, the cause could be
-that the system was restarted while a garbage collection cycle was in progress.
-Such a condition is identified by the presence of two areas with the same ID.
-In such a case, the shorter of the two areas is erased and designated as the
-scratch area.
-
-
-## Formatting
-
-A new file system is created via formatting. Formatting is achieved via the
-following function:
-
-```no-highlight
-/**
- * Erases all the specified areas and initializes them with a clean nffs
- * file system.
- *
- * @param area_descs The set of areas to format.
- *
- * @return 0 on success;
- * nonzero on failure.
- */
-int nffs_format(const struct nffs_area_desc *area_descs);
-```
-
-On success, an area header is written to each of the specified locations. The
-largest area in the set is designated as the initial scratch area.
-
-
-## Flash writes
-
-The nffs implementation always writes in a strictly sequential fashion within an
-area. For each area, the system keeps track of the current offset. Whenever
-an object gets written to an area, it gets written to that area's current
-offset, and the offset is increased by the object's disk size.
-
-When a write needs to be performed, the nffs implementation selects the
-appropriate destination area by iterating though each area until one with
-sufficient free space is encountered.
-
-There is no write buffering. Each call to a write function results in a write
-operation being sent to the flash hardware.
-
-
-### New objects
-
-Whenever a new object is written to disk, it is assigned the following
-properties:
- * ID: A unique value is selected from the 32-bit ID space, as appropriate
- for the object's type.
- * Sequence number: 0
-
-When a new file or directory is created, a corresponding inode is written to
-flash. Likewise, a new data block also results in the writing of a
-corresponding disk object.
-
-
-### Moving/Renaming files and directories
-
-When a file or directory is moved or renamed, its corresponding inode is
-rewritten to flash with the following properties:
-
-* ID: Unchanged
-* Sequence number: Previous value plus one.
-* Parent inode: As specified by the move / rename operation.
-* Filename: As specified by the move / rename operation.
-
-Because the inode's ID is unchanged, all dependent objects remain valid.
-
-
-### Unlinking files and directories
-
-When a file or directory is unlinked from its parent directory, a deletion
-record for the unlinked inode gets written to flash. The deletion record is an
-inode with the following properties:
-
-* ID: Unchanged
-* Sequence number: Previous value plus one.
-* Parent inode ID: NFFS_ID_NONE
-
-When an inode is unlinked, no deletion records need to be written for the
-inode's dependent objects (constituent data blocks or child inodes). During
-the next file system detection, it is recognized that the objects belong to
-a deleted inode, so they are not restored into the RAM representation.
-
-If a file has an open handle at the time it gets unlinked, application code
-can continued to use the file handle to read and write data. All files retain
-a reference count, and a file isn't deleted from the RAM representation until
-its reference code drops to 0. Any attempt to open an unlinked file fails,
-even if the file is referenced by other file handles.
-
-
-### Writing to a file
-
-The following procedure is used whenever the application code writes to a file.
-First, if the write operation specifies too much data to fit into a single
-block, the operation is split into several separate write operations. Then,
-for each write operation:
-
-1\. Determine which existing blocks the write operation overlaps (n = number of overwritten blocks).
-
-2\. If n = 0, this is an append operation. Write a data block with the following properties:
-
- * ID: New unique value.
- * Sequence number: 0.
-
-3\. Else (n > 1), this write overlaps existing data.
-
- (a) For each block in [1, 2, ... n-1], write a new block containing the updated contents. Each new block supersedes the block it overwrites. That is, each block has the following properties:
-
- * ID: Unchanged
- * Sequence number: Previous value plus one.
-
- (b) Write the nth block. The nth block includes all appended data, if any. As with the other blocks, its ID is unchanged and its sequence number is incremented.
-
-Appended data can only be written to the end of the file. That is, "holes" are
-not supported.
-
-
-## 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:
-
-* 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."
-
-* The RAM representation is exhaustively searched for collectible objects. The following procedure is applied to each inode in the system:
- * If the inode is resident in the source area, copy the inode record to the destination area.
- * If the inode is a file inode, walk the inode's list of data blocks, starting with the last block in the file. Each block that is resident in the source area is copied to the destination area. If there is a run of two or more blocks that are resident in the source area, they are consolidated and copied to the destination area as a single new block (subject to the maximum block size restriction).
-
-* The source area is reformatted as a scratch sector (i.e., is is fully erased, and its header is rewritten with an ID of 0xff). The area's garbage collection sequence number is incremented prior to rewriting the header. This area is now the new scratch sector.
-
-
-## Miscellaneous measures
-
-* RAM usage:
- * 24 bytes per inode
- * 12 bytes per data block
- * 36 bytes per inode cache entry
- * 32 bytes per data block cache entry
-
-* Maximum filename size: 256 characters (no null terminator required)
-* Disallowed filename characters: '/' and '\0'
-
-
-## Future enhancements
-
-* API function to traverse a directory.
-* Migrate corrupt files to the /lost+found directory during restore, rather than discarding them from RAM.
-* Error correction.
-* Encryption.
-* Compression.
-
-
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shell/shell.md
----------------------------------------------------------------------
diff --git a/docs/modules/shell/shell.md b/docs/modules/shell/shell.md
deleted file mode 100644
index db575bc..0000000
--- a/docs/modules/shell/shell.md
+++ /dev/null
@@ -1,115 +0,0 @@
-# Shell
-
-The shell is the program which puts up a prompt for a command, processes commands, and returns output. Interacting with the console of a device is done using a shell program.
-
-
-## Description
-
-Shell processes console input one line at a time. Eggs can register handlers for their commands. Shell parses the input, matches it against the set of registered commands, and then calls the handler it finds.
-
-A few commands are currently available in the shell - `tasks`, `log`, and `stat stat`. A $ prompt sign will be coming soon!
-
-Create a sim target to check out these commands available in shell.
-
-```no-highlight
-user@~/dev/larva$ newt target create blinky_sim
-Creating target blinky_sim
-Target blinky_sim successfully created!
-user@~/dev/larva$ newt target set blinky_sim name=blinky_sim
-Target blinky_sim successfully set name to blinky_sim
-user@~/dev/larva$ newt target set blinky_sim arch=sim
-Target blinky_sim successfully set arch to sim
-user@~/dev/larva$ newt target set blinky_sim project=blinky
-Target blinky_sim successfully set project to blinky
-user@~/dev/larva$ newt target set blinky_sim bsp=hw/bsp/native
-Target blinky_sim successfully set bsp to hw/bsp/native
-user@~/dev/larva$ newt target set blinky_sim compiler_def=debug
-Target blinky_sim successfully set compiler_def to debug
-user@~/dev/larva$ newt target set blinky_sim compiler=sim
-Target blinky_sim successfully set compiler to sim
-user@~/dev/larva$ newt target show
-blinky_sim
- arch: sim
- bsp: hw/bsp/native
- compiler: sim
- compiler_def: debug
- name: blinky_sim
- project: blinky
-user@~/dev/larva$ newt target build blinky_sim
-Building target blinky_sim (project = blinky)
-Compiling case.c
-Compiling suite.c
-Compiling testutil.c
-..
-..
-Building project blinky
-Linking blinky.elf
-Successfully run!
-
-user@~/dev/larva$ ./project/blinky/bin/blinky_sim/blinky.elf
-uart0 at /dev/ttys005
-
-```
-
-Open up a new terminal to run minicom, a text-based serial port control and terminal emulation program. Set device name to the serial port of the target.
-
-```no-highlight
-user@~$ minicom -D /dev/ttys005
-Welcome to minicom 2.7
-
-OPTIONS:
-Compiled on Nov 24 2015, 16:14:21.
-Port /dev/ttys005, 11:32:17
-
-Press Meta-Z for help on special keys
-
-log
-174578:[0] bla
-174578:[0] bab
-
-tasks
-217809:6 tasks:
-217809: shell (prio: 3, nw: 0, flags: 0x0, ssize: 0, cswcnt: 59, tot_run_time: 0ms)
-217840: idle (prio: 255, nw: 0, flags: 0x0, ssize: 0, cswcnt: 18763, tot_run_time: 217809ms)
-217878: uart_poller (prio: 0, nw: 217819, flags: 0x0, ssize: 0, cswcnt: 18667, tot_run_time: 0ms)
-217923: task1 (prio: 1, nw: 218710, flags: 0x0, ssize: 0, cswcnt: 218, tot_run_time: 0ms)
-217953: os_sanity (prio: 254, nw: 218710, flags: 0x0, ssize: 0, cswcnt: 218, tot_run_time: 0ms)
-218010: task2 (prio: 2, nw: 217709, flags: 0x3, ssize: 0, cswcnt: 218, tot_run_time: 0ms)
-
-stat stat
-229881:s0: 1
-
-```
-
-
-## Data structures
-
-Replace this with the list of data structures used, why, any neat features
-
-## List of Functions
-
-<Comments such as these instructions are placed within angle brackets. List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the header has to have at least 2 words for the anchor to work - that's how it is. "no-highlight" disables syntax highlighting. You can enable it for a particular language by specifying what the language is instead of "no-highlight". Be warned that this highlighting or no-highlighting specification may not show up nicely on Mou.>
-
-The functions available in this OS feature are:
-
-* [shell_cmd](shell_cmd.md)
-* [shell_cmd_list_lock](shell_cmd_list_lock.md)
-* [shell_cmd_list_unlock](shell_cmd_list_unlock.md)
-* [shell_cmd_register](shell_cmd_register.md)
-* [shell_console_rx_cb](shell_console_rx_cb.md)
-* [shell_echo_cmd](shell_echo_cmd.md)
-* [shell_help_cmd](shell_help_cmd.md)
-* [shell_nlip_input_register](shell_nlip_input_register.md)
-* [shell_nlip_mqueue_process](shell_nlip_mqueue_process.md)
-* [shell_nlip_mtx](shell_nlip_mtx.md)
-* [shell_nlip_output](shell_nlip_output.md)
-* [shell_nlip_process](shell_nlip_process.md)
-* [shell_os_mpool_display_cmd](shell_os_mpool_display_cmd.md)
-* [shell_os_tasks_display_cmd](shell_os_tasks_display_cmd.md)
-* [shell_process_command](shell_process_command.md)
-* [shell_read_console](shell_read_console.md)
-* [shell_task_func](shell_task_func.md)
-* [shell_task_init](shell_task_init.md)
-
-
-
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shell/shell_cmd.md
----------------------------------------------------------------------
diff --git a/docs/modules/shell/shell_cmd.md b/docs/modules/shell/shell_cmd.md
deleted file mode 100644
index 4aad702..0000000
--- a/docs/modules/shell/shell_cmd.md
+++ /dev/null
@@ -1,39 +0,0 @@
-## <font color="F2853F" style="font-size:24pt"> shell_cmd </font>
-
-```no-highlight
- static int
- shell_cmd(char *cmd, char **argv, int argc)
-```
-
-<Put description here>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| arg1 | description |
-| arg2 | description |
-| arg3 | description |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-What to look out for, special cases, things to consider
-
-#### Example
-
-
-
-```no-highlight
-
- give an example
-
-```
-
----------------------
-
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shell/shell_cmd_list_lock.md
----------------------------------------------------------------------
diff --git a/docs/modules/shell/shell_cmd_list_lock.md b/docs/modules/shell/shell_cmd_list_lock.md
deleted file mode 100644
index 44977cb..0000000
--- a/docs/modules/shell/shell_cmd_list_lock.md
+++ /dev/null
@@ -1,39 +0,0 @@
-## <font color="F2853F" style="font-size:24pt"> shell_cmd_list_lock </font>
-
-```no-highlight
- static int
- shell_cmd_list_lock(void)
-```
-
-<Put description here>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| arg1 | description |
-| arg2 | description |
-| arg3 | description |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-What to look out for, special cases, things to consider
-
-#### Example
-
-
-
-```no-highlight
-
- give an example
-
-```
-
----------------------
-
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shell/shell_cmd_list_unlock.md
----------------------------------------------------------------------
diff --git a/docs/modules/shell/shell_cmd_list_unlock.md b/docs/modules/shell/shell_cmd_list_unlock.md
deleted file mode 100644
index 6604294..0000000
--- a/docs/modules/shell/shell_cmd_list_unlock.md
+++ /dev/null
@@ -1,38 +0,0 @@
-## <font color="F2853F" style="font-size:24pt"> shell_cmd_list_unlock </font>
-
-```no-highlight
- static int
- shell_cmd_list_unlock(void)
-```
-
-<Put description here>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| arg1 | description |
-| arg2 | description |
-| arg3 | description |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-What to look out for, special cases, things to consider
-
-#### Example
-
-
-
-```no-highlight
-
- give an example
-
-```
-
----------------------
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shell/shell_cmd_register.md
----------------------------------------------------------------------
diff --git a/docs/modules/shell/shell_cmd_register.md b/docs/modules/shell/shell_cmd_register.md
deleted file mode 100644
index 9d2b3d6..0000000
--- a/docs/modules/shell/shell_cmd_register.md
+++ /dev/null
@@ -1,46 +0,0 @@
-```no-highlight
- int
- shell_cmd_register(struct shell_cmd *sc, char *cmd, shell_cmd_func_t func)
-```
-
-Register a shell command. When shell reads a line of input which starts with `cmd`, it calls the handler `func`. Caller must allocate data structure `sc`. Shell internally links this to it's list of command handlers.
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| sc | Pointer to data structure shell egg uses to store info about the registered command |
-| cmd | Command getting registered |
-| func | Function to call when command is received from console |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Shell splits the arguments following the command into an array of character pointers, and passes these to registered handler. The function will be called in shell task's context, so the command handler should look out for possible issues due to concurrency.
-
-#### Example
-
-Here is FS registering command for 'ls'.
-
-```no-highlight
-static struct shell_cmd fs_ls_struct;
-
-void
-fs_cli_init(void)
-{
- int rc;
-
- rc = shell_cmd_register(&fs_ls_struct, "ls", fs_ls_cmd);
- if (rc != 0) {
- return;
- }
-}
-
-```
-
----------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shell/shell_console_rx_cb.md
----------------------------------------------------------------------
diff --git a/docs/modules/shell/shell_console_rx_cb.md b/docs/modules/shell/shell_console_rx_cb.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shell/shell_echo_cmd.md
----------------------------------------------------------------------
diff --git a/docs/modules/shell/shell_echo_cmd.md b/docs/modules/shell/shell_echo_cmd.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shell/shell_help_cmd.md
----------------------------------------------------------------------
diff --git a/docs/modules/shell/shell_help_cmd.md b/docs/modules/shell/shell_help_cmd.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shell/shell_nlip_input_register.md
----------------------------------------------------------------------
diff --git a/docs/modules/shell/shell_nlip_input_register.md b/docs/modules/shell/shell_nlip_input_register.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shell/shell_nlip_mqueue_process.md
----------------------------------------------------------------------
diff --git a/docs/modules/shell/shell_nlip_mqueue_process.md b/docs/modules/shell/shell_nlip_mqueue_process.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shell/shell_nlip_mtx.md
----------------------------------------------------------------------
diff --git a/docs/modules/shell/shell_nlip_mtx.md b/docs/modules/shell/shell_nlip_mtx.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shell/shell_nlip_output.md
----------------------------------------------------------------------
diff --git a/docs/modules/shell/shell_nlip_output.md b/docs/modules/shell/shell_nlip_output.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shell/shell_nlip_process.md
----------------------------------------------------------------------
diff --git a/docs/modules/shell/shell_nlip_process.md b/docs/modules/shell/shell_nlip_process.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shell/shell_os_mpool_display_cmd.md
----------------------------------------------------------------------
diff --git a/docs/modules/shell/shell_os_mpool_display_cmd.md b/docs/modules/shell/shell_os_mpool_display_cmd.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shell/shell_os_tasks_display_cmd.md
----------------------------------------------------------------------
diff --git a/docs/modules/shell/shell_os_tasks_display_cmd.md b/docs/modules/shell/shell_os_tasks_display_cmd.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shell/shell_process_command.md
----------------------------------------------------------------------
diff --git a/docs/modules/shell/shell_process_command.md b/docs/modules/shell/shell_process_command.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shell/shell_read_console.md
----------------------------------------------------------------------
diff --git a/docs/modules/shell/shell_read_console.md b/docs/modules/shell/shell_read_console.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shell/shell_task_func.md
----------------------------------------------------------------------
diff --git a/docs/modules/shell/shell_task_func.md b/docs/modules/shell/shell_task_func.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shell/shell_task_init.md
----------------------------------------------------------------------
diff --git a/docs/modules/shell/shell_task_init.md b/docs/modules/shell/shell_task_init.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shelltest/imgmgr_module_init.md
----------------------------------------------------------------------
diff --git a/docs/modules/shelltest/imgmgr_module_init.md b/docs/modules/shelltest/imgmgr_module_init.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shelltest/imgr_boot_read.md
----------------------------------------------------------------------
diff --git a/docs/modules/shelltest/imgr_boot_read.md b/docs/modules/shelltest/imgr_boot_read.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shelltest/imgr_boot_write.md
----------------------------------------------------------------------
diff --git a/docs/modules/shelltest/imgr_boot_write.md b/docs/modules/shelltest/imgr_boot_write.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shelltest/imgr_file_download.md
----------------------------------------------------------------------
diff --git a/docs/modules/shelltest/imgr_file_download.md b/docs/modules/shelltest/imgr_file_download.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shelltest/imgr_file_upload.md
----------------------------------------------------------------------
diff --git a/docs/modules/shelltest/imgr_file_upload.md b/docs/modules/shelltest/imgr_file_upload.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shelltest/imgr_list.md
----------------------------------------------------------------------
diff --git a/docs/modules/shelltest/imgr_list.md b/docs/modules/shelltest/imgr_list.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shelltest/imgr_noop.md
----------------------------------------------------------------------
diff --git a/docs/modules/shelltest/imgr_noop.md b/docs/modules/shelltest/imgr_noop.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shelltest/imgr_read_file.md
----------------------------------------------------------------------
diff --git a/docs/modules/shelltest/imgr_read_file.md b/docs/modules/shelltest/imgr_read_file.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shelltest/imgr_read_main.md
----------------------------------------------------------------------
diff --git a/docs/modules/shelltest/imgr_read_main.md b/docs/modules/shelltest/imgr_read_main.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shelltest/imgr_read_test.md
----------------------------------------------------------------------
diff --git a/docs/modules/shelltest/imgr_read_test.md b/docs/modules/shelltest/imgr_read_test.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shelltest/imgr_read_ver.md
----------------------------------------------------------------------
diff --git a/docs/modules/shelltest/imgr_read_ver.md b/docs/modules/shelltest/imgr_read_ver.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shelltest/imgr_upload.md
----------------------------------------------------------------------
diff --git a/docs/modules/shelltest/imgr_upload.md b/docs/modules/shelltest/imgr_upload.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shelltest/imgr_ver_jsonstr.md
----------------------------------------------------------------------
diff --git a/docs/modules/shelltest/imgr_ver_jsonstr.md b/docs/modules/shelltest/imgr_ver_jsonstr.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shelltest/imgr_ver_parse.md
----------------------------------------------------------------------
diff --git a/docs/modules/shelltest/imgr_ver_parse.md b/docs/modules/shelltest/imgr_ver_parse.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shelltest/imgr_ver_str.md
----------------------------------------------------------------------
diff --git a/docs/modules/shelltest/imgr_ver_str.md b/docs/modules/shelltest/imgr_ver_str.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9b0bc2e0/docs/modules/shelltest/imgr_write_file.md
----------------------------------------------------------------------
diff --git a/docs/modules/shelltest/imgr_write_file.md b/docs/modules/shelltest/imgr_write_file.md
deleted file mode 100644
index e69de29..0000000