PPAPI: Add Quota info to PPB_FileSystem::Open doc

PPAPI: Add Quota info to PPB_FileSystem::Open doc

BUG=NONE
TEST=NONE


Committed: http://src.chromium.org/viewvc/chrome?view=rev&revision=146051

[dmichael (off chromium), 2012-07-10 02:54:55]

Forgot I had this little CL sitting around...

[ivan_cobs.com.sg, 2012-07-10 03:47:09]

Pls remove the following email adds from your list NOW

ivan@cobs.com.sg
lynn@cobs.com.sg

-----Original Message-----
From: dmichael@chromium.org [mailto:dmichael@chromium.org] 
Sent: Tuesday, 10 July, 2012 10:55 AM
To: bbudge@chromium.org
Cc: chromium-reviews@chromium.org; piman+watch@chromium.org;
darin-cc@chromium.org; yzshen+watch@chromium.org; ihf+watch@chromium.org
Subject: [chromium-reviews] PPAPI: Add Quota info to PPB_FileSystem::Open
doc (issue 10413036)

Reviewers: bbudge1,

Message:
Forgot I had this little CL sitting around...

Description:
PPAPI: Add Quota info to PPB_FileSystem::Open doc

BUG=NONE
TEST=NONE


Please review this at http://codereview.chromium.org/10413036/

SVN Base: svn://svn.chromium.org/chrome/trunk/src

Affected files:
   M ppapi/api/ppb_file_system.idl
   M ppapi/c/ppb_file_system.h
   M ppapi/cpp/file_system.h


Index: ppapi/api/ppb_file_system.idl
diff --git a/ppapi/api/ppb_file_system.idl b/ppapi/api/ppb_file_system.idl
index
1675d30282de101d756bdacf10029677b87af506..4cad1eb5358c22d697060681c8d8b5ca25
f58bfe
100644
--- a/ppapi/api/ppb_file_system.idl
+++ b/ppapi/api/ppb_file_system.idl
@@ -46,7 +46,14 @@ interface PPB_FileSystem {
     *
     * @param[in] file_system A <code>PP_Resource</code> corresponding to a
file
     * system.
-   * @param[in] expected_size The expected size of the file system.
+   *
+   * @param[in] expected_size The expected size of the file system. 
+ Note
that
+   * this does not request quota; to do that, you must either invoke
+   * requestQuota from JavaScript:
+   *
http://www.html5rocks.com/en/tutorials/file/filesystem/#toc-requesting-quota
+   * or set the unlimitedStorage permission for Chrome Web Store apps:
+   * http://code.google.com/chrome/extensions/manifest.html#permissions
+   *
     * @param[in] callback A <code>PP_CompletionCallback</code> to be called
upon
     * completion of Open().
     *
Index: ppapi/c/ppb_file_system.h
diff --git a/ppapi/c/ppb_file_system.h b/ppapi/c/ppb_file_system.h index
8eb94a15278fb33238f9d1fb2f8d042883a14435..73910d6caef864b0fad5b0e5c86f95d518
7b800c
100644
--- a/ppapi/c/ppb_file_system.h
+++ b/ppapi/c/ppb_file_system.h
@@ -3,7 +3,7 @@
   * found in the LICENSE file.
   */

-/* From ppb_file_system.idl modified Mon Mar 19 11:36:09 2012. */
+/* From ppb_file_system.idl modified Mon May 21 15:19:32 2012. */

  #ifndef PPAPI_C_PPB_FILE_SYSTEM_H_
  #define PPAPI_C_PPB_FILE_SYSTEM_H_
@@ -62,7 +62,16 @@ struct PPB_FileSystem_1_0 {
     *
     * @param[in] file_system A <code>PP_Resource</code> corresponding to a
file
     * system.
-   * @param[in] expected_size The expected size of the file system.
+   *
+   * @param[in] expected_size The expected size of the file system. 
+ Note
that
+   * this does not request quota; to do that, you must either invoke
+   * requestQuota from JavaScript:
+
+
+    *
http://www.html5rocks.com/en/tutorials/file/filesystem/#toc-requesting-quota
+   * or set the unlimitedStorage permission for Chrome Web Store apps:
+   * http://code.google.com/chrome/extensions/manifest.html#permissions
+   *
     * @param[in] callback A <code>PP_CompletionCallback</code> to be called
upon
     * completion of Open().
     *
Index: ppapi/cpp/file_system.h
diff --git a/ppapi/cpp/file_system.h b/ppapi/cpp/file_system.h index
8aea7a555c5fb3ae6a1981df7293738211de609a..ab95a334cf2fa5b0a89f81c0bffab6958f
84241b
100644
--- a/ppapi/cpp/file_system.h
+++ b/ppapi/cpp/file_system.h
@@ -40,7 +40,13 @@ class FileSystem : public Resource {
    /// Open() opens the file system. A file system must be opened before
running
    /// any other operation on it.
    ///
-  /// @param[in] expected_size The expected size of the file system.
+  /// @param[in] expected_size The expected size of the file system. 
+ Note
that
+  /// this does not request quota; to do that, you must either invoke  
+ /// requestQuota from JavaScript:
+  ///
http://www.html5rocks.com/en/tutorials/file/filesystem/#toc-requesting-quota
+  /// or set the unlimitedStorage permission for Chrome Web Store apps:
+  /// 
+ http://code.google.com/chrome/extensions/manifest.html#permissions
+  ///
    /// @param[in] cc A <code>PP_CompletionCallback</code> to be called upon
    /// completion of Open().
    ///

[bbudge, 2012-07-10 15:11:51]

lgtm

[commit-bot: I haz the power, 2012-07-11 02:33:49]

CQ is trying da patch. Follow status at
https://chromium-status.appspot.com/cq/dmichael@chromium.org/10413036/1

[commit-bot: I haz the power, 2012-07-11 03:45:45]

Change committed as 146051