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

[02/15] incubator-mynewt-site git commit: fs/fs docs: Replace outdated text.

fs/fs docs: Replace outdated text.

* project --> app
* prefix paths with "repos/apache-mynewt-core/"


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

Branch: refs/heads/master
Commit: 8ace814e438c8ff50198fa9347384c086fb9fb6c
Parents: 1b5a965
Author: Christopher Collins <cc...@apache.org>
Authored: Wed May 18 07:53:22 2016 -0700
Committer: Christopher Collins <cc...@apache.org>
Committed: Wed May 18 08:07:22 2016 -0700

----------------------------------------------------------------------
 docs/os/modules/fs/fs/fs.md | 16 +++++++---------
 1 file changed, 7 insertions(+), 9 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8ace814e/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 78655b0..ea9528f 100644
--- a/docs/os/modules/fs/fs/fs.md
+++ b/docs/os/modules/fs/fs/fs.md
@@ -4,15 +4,14 @@ Mynewt provides a file system abstraction layer (`fs/fs`) to allow client code t
 
 ###Description
 
-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 the simplest case, the only code which needs to know which file system is in use is the code which initializes the file system.  In terms of the Mynewt hierarchy, the **project** package must depend on a specific file system package, while **library** packages should only depend on `fs/fs`.
+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 the simplest case, the only code which needs to know which file system is in use is the code which initializes the file system.  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`.
 
-The following example illustrates how file system dependencies should be managed.  In the slinky application, the project is responsible for initializing the file system, so it depends on a concrete file system package called `fs/nffs` (Newtron Flash File System). The project explicitly initializes nffs via calls to `nffs_init()`, `nffs_detect()` and `nffs_format()`.
+The following example illustrates how file system dependencies should be managed.  In the slinky application, the app is responsible for initializing the file system, so it depends on a concrete file system package called `fs/nffs` (Newtron Flash File System). The app explicitly initializes nffs via calls to `nffs_init()`, `nffs_detect()` and `nffs_format()`.
 
 ```no-highlight
-# project/slinky/pkg.yml
+# repos/apache-mynewt-core/apps/slinky/pkg.yml
 
-pkg.name: project/slinky
-pkg.vers: 0.8.0
+pkg.name: repos/apache-mynewt-core/apps/slinky
 pkg.deps:
     - fs/nffs
 
@@ -20,7 +19,7 @@ pkg.deps:
 ```
 
 ```no-highlight
-// project/slinky/src/main.c
+/* repos/apache-mynewt-core/apps/slinky/src/main.c */
 
 #include "nffs/nffs.h"
 
@@ -45,12 +44,11 @@ main(int argc, char **argv)
 }
 ```
 
-On the other hand, code which uses the file system after it 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 main project has initialized the file system, and therefore only depends on the `fs/fs` package.
+On the other hand, code which uses the file system after it 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 main app has initialized the file system, and therefore only depends on the `fs/fs` package.
 
 ```no-highlight
-# libs/imgmgr/pkg.yml
+# repos/apache-mynewt-core/libs/imgmgr/pkg.yml
 pkg.name: libs/imgmgr
-pkg.vers: 0.8.0
 pkg.deps:
     - fs/fs