cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From agri...@apache.org
Subject git commit: Remove docs about filesystems from file-system-roots -> file
Date Thu, 17 Apr 2014 13:13:24 GMT
Repository: cordova-plugins
Updated Branches:
  refs/heads/master 80561e433 -> c4ca22bf9


Remove docs about filesystems from file-system-roots -> file


Project: http://git-wip-us.apache.org/repos/asf/cordova-plugins/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-plugins/commit/c4ca22bf
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugins/tree/c4ca22bf
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugins/diff/c4ca22bf

Branch: refs/heads/master
Commit: c4ca22bf9bb6fa0a259181f61436a8d212aa7db1
Parents: 80561e4
Author: Andrew Grieve <agrieve@chromium.org>
Authored: Thu Apr 17 09:12:08 2014 -0400
Committer: Andrew Grieve <agrieve@chromium.org>
Committed: Thu Apr 17 09:12:37 2014 -0400

----------------------------------------------------------------------
 file-system-roots/README.md          | 46 ++++---------------------------
 file-system-roots/filesystemroots.js |  1 -
 2 files changed, 5 insertions(+), 42 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-plugins/blob/c4ca22bf/file-system-roots/README.md
----------------------------------------------------------------------
diff --git a/file-system-roots/README.md b/file-system-roots/README.md
index 68ed7f9..b4cb594 100644
--- a/file-system-roots/README.md
+++ b/file-system-roots/README.md
@@ -1,46 +1,7 @@
 org.apache.cordova.file-system-roots plugin
 ===========================================
 
-This plugin grants a Cordova application access to several additional filesystem roots, and
provides a cross-platform means of accessing these filesystems based on their intended purpose.
-
-The set of available filesystems depends on the platform.
-
-Android
--------
-
-    - files: The application's internal file storage directory
-    - files-external: The application's external file storage directory
-    - sdcard: The global external file storage directory (this is the root of the SD card,
if one is installed)
-    - cache: The application's internal cache directory
-    - cache-external: The application's external cache directory
-    - root: The entire device filesystem
-
-Android also supports a special filesystem named "documents", which represents a "/Documents/"
subdirectory within the "files" filesystem.
-
-iOS
----
-
-    - library: The application's Library directory
-    - documents: The application's Documents directory
-    - cache: The application's Cache directory
-    - app-bundle: The application's bundle; the location of the app itself on disk
-    - root: The entire device filesystem
-
-By default, the library and documents directories can be synced to iCloud. You can also request
two additional filesystems, "library-nosync" and "documents-nosync", which represent a special
non-synced directory within the Library or Documents filesystem.
-
-Configuring the plugin
-----------------------
-
-The set of available filesystems can be configured at build time per-platform. Both iOS and
Android recognize a <preference> tag in `config.xml` which names the filesystems to
be installed. The defaults for these preferences, if not set, are
-
-    <preference name="iosExtraFilesystems" value="library,library-nosync,documents,documents-nosync,cache,bundle"
/>
-
-    <preference name="AndroidExtraFilesystems" value="files,files-external,documents,sdcard,cache,cache-external"
/>
-
-These defaults contain all available filesystems except for "root".
-
-Accessing the filesystems
--------------------------
+This plugin provides getters for important filesystem locations (based on OS).
 
 The simplest method of using these new filesystems is to call `cordova.filesystem.getFilesystem`
with the name of the filesystem you want to use.
 
@@ -62,4 +23,7 @@ The following string constants are defined for the `purpose` field:
     temp        (returns the TEMPORARY filesystem)
     app-bundle  (iOS only)
 
-The `options` field is an object. On iOS, it is possible to set it to `{syncable: false}`
to obtain the non-synced versions of `data` or `documents`. On Android, you can set `{sandboxed:
false}` to get the external (not confined to your app) versions of `data`, `documents` or
`cache`.
+The `options` field is an object. On iOS, it is possible to set it to
+`{syncable: false}` to obtain the non-synced versions of `data` or `documents`.
+On Android, you can set `{sandboxed: false}` to get the external (not confined
+to your app) versions of `data`, `documents` or `cache`.

http://git-wip-us.apache.org/repos/asf/cordova-plugins/blob/c4ca22bf/file-system-roots/filesystemroots.js
----------------------------------------------------------------------
diff --git a/file-system-roots/filesystemroots.js b/file-system-roots/filesystemroots.js
index fa51afb..13ded3e 100644
--- a/file-system-roots/filesystemroots.js
+++ b/file-system-roots/filesystemroots.js
@@ -70,7 +70,6 @@ exports.getDataDirectory = function(syncable, successCallback) {
     exports.getDirectoryForPurpose('data', { syncable: syncable }, successCallback);
 };
 
-// On Android, this is the root of the SD card.
 exports.getDocumentsDirectory = function(successCallback) {
     exports.getDirectoryForPurpose('documents', { syncable: true, sandboxed: false }, successCallback);
 };


Mime
View raw message