cordova-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From kerrishotts <...@git.apache.org>
Subject [GitHub] cordova-plugin-file pull request: [CB- 7057] Improve File API docu...
Date Tue, 01 Jul 2014 01:19:26 GMT
GitHub user kerrishotts opened a pull request:

    https://github.com/apache/cordova-plugin-file/pull/59

    [CB- 7057] Improve File API documentation, especially wrt to cordova.file.* properties

    As discussed on the google groups, the documentation for the `cordova.file.*` properties
is unclear (see post: https://groups.google.com/forum/#!topic/phonegap/W1ZR6WG5XwM). Revised
documentation to make it clearer, and also added a table indicating how the properties relate
to the file system and the various properties on each path (read-write, private, etc.)
    
    Bug # is CB-7057.


You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/kerrishotts/cordova-plugin-file CB-7057

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/cordova-plugin-file/pull/59.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #59
    
----
commit da486e42ec3d5908f8013f9f2a6c42e7aca0a7f5
Author: Kerri Shotts <kerrishotts@gmail.com>
Date:   2014-07-01T01:06:37Z

    Reworded description
    
    Added note that under iOS this directory is read-only (one must use a
    subdirectory like /Documents). Also indicated that the contents within
    the folder are private.

commit 2575d9e714f020954fa251d733a6415a2f2f1f76
Author: Kerri Shotts <kerrishotts@gmail.com>
Date:   2014-07-01T01:07:31Z

    Reworded description
    
    Reworded to make it clear that the data is persistent and private and
    within internal memory. Also added additional options for Android if
    external memory is needed and indicated that this directory is not
    synced.

commit d6b44960f640f9d2326968f5fd2795d40543d825
Author: Kerri Shotts <kerrishotts@gmail.com>
Date:   2014-07-01T01:09:05Z

    Reworded description
    
    Based on email from @jcesarmobile in dev group (titled More questions
    on FileSystem directories)

commit 3bda96d6939f2b69380573ffbec7b958af0fce8a
Author: Kerri Shotts <kerrishotts@gmail.com>
Date:   2014-07-01T01:09:42Z

    Reformatted as list

commit bdc14902bfc22fc86b1f790dbc8297598868c87f
Author: Kerri Shotts <kerrishotts@gmail.com>
Date:   2014-07-01T01:09:58Z

    Added note not to rely on OS clearing

commit 9ea0c3cc74fdce67d42dbbe6c2d2022ea508483b
Author: Kerri Shotts <kerrishotts@gmail.com>
Date:   2014-07-01T01:11:03Z

    Added file system layout information
    
    This is useful information, especially for native developers who may
    already be familiar with the file system, but also useful for marking
    which directories are writeable, which ones are private/public and
    which ones sync, etc.

commit 2a0f0884d063171a8099c35022ea579398c06482
Author: Kerri Shotts <kerrishotts@gmail.com>
Date:   2014-07-01T01:12:09Z

    Formatting

commit 80b172361ba71c318041d29ecf917ce8b8bc8708
Author: Kerri Shotts <kerrishotts@gmail.com>
Date:   2014-07-01T01:12:32Z

    Promoted heading
    
    To match Android/iOS quirk headings

commit 1175156cecf7f5e581fa653451e0a03b737593cf
Author: Kerri Shotts <kerrishotts@gmail.com>
Date:   2014-07-01T01:12:41Z

    Converted to table

commit 67f929bfba49e321c91eb4abd157f1a20ee0776a
Author: Kerri Shotts <kerrishotts@gmail.com>
Date:   2014-07-01T01:12:59Z

    Added quirk
    
    Noted that `applicationStorageDirectory` is read-only.

commit f1e18ebba1193031beb8b81f12b3a7bd59d21abd
Author: Kerri Shotts <kerrishotts@gmail.com>
Date:   2014-07-01T01:13:10Z

    formatting

----


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message