You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by pe...@apache.org on 2017/01/09 23:29:26 UTC
incubator-mynewt-site git commit: Add link to nffs for further
explanation
Repository: incubator-mynewt-site
Updated Branches:
refs/heads/develop fddb472da -> c47ec5579
Add link to nffs for further explanation
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/c47ec557
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/c47ec557
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/c47ec557
Branch: refs/heads/develop
Commit: c47ec5579c6cafe8112af80dc858f1d87a29e267
Parents: fddb472
Author: Peter Snyder <pe...@apache.org>
Authored: Mon Jan 9 15:28:50 2017 -0800
Committer: Peter Snyder <pe...@apache.org>
Committed: Mon Jan 9 15:28:50 2017 -0800
----------------------------------------------------------------------
docs/os/modules/fs/fs/fs.md | 11 +++++------
1 file changed, 5 insertions(+), 6 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c47ec557/docs/os/modules/fs/fs/fs.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/fs/fs/fs.md b/docs/os/modules/fs/fs/fs.md
index 71a8125..188ad49 100644
--- a/docs/os/modules/fs/fs/fs.md
+++ b/docs/os/modules/fs/fs/fs.md
@@ -6,12 +6,11 @@ Mynewt provides a file system abstraction layer (`fs/fs`) to allow client code t
Applications should aim to minimize the amount of code which depends on a particular file system implementation. When possible, only depend on the
`fs/fs` package.
-In terms of the Mynewt hierarchy, the **app** package must depend on a specific file system package, while **library** packages should only depend on `fs/fs`.
+In terms of the Mynewt hierarchy, an **app** package must depend on a specific file system package, while **library** packages should only depend on `fs/fs`.
-Applications wanting to access a filesystem are required to responsible for
-including the necessary packages in their applications pkg.yml file.
-
-the file system, so it depends on a concrete file system package called `fs/nffs` (Newtron Flash File System).
+Applications wanting to access a filesystem are required to include the necessary packages in their applications pkg.yml file.
+In the following example, the [`Newtron Flash File System`](../nffs/nffs.md)
+is used.
```no-highlight
# repos/apache-mynewt-core/apps/slinky/pkg.yml
@@ -28,12 +27,12 @@ pkg.deps:
# Package: apps/<example app>
# [...]
CONFIG_NFFS: 1 # initialize and configure NFFS into the system
-# Consult the documentation for nffs for a broader explanation of NFFS_DETECT_FAIL
# NFFS_DETECT_FAIL: 1 # Ignore NFFS detection issues
# NFFS_DETECT_FAIL: 2 # Format a new NFFS file system on failure to detect
# [...]
```
+Consult the documentation for [`nffs`](../nffs/nffs.md) for a more detailed explanation of NFFS_DETECT_FAIL
Code which uses the file system after the system has been initialized need only depend on `fs/fs`. For example, the `libs/imgmgr` package is a library which provides firmware upload and download functionality via the use of a file system. This library is only used after the system has been initialized, and therefore only depends on the `fs/fs` package.