CDRIVER-852 document that gridfs timeout is unused

Author: ajdavis

doc/mongoc_gridfs_file_readv.page

@@ -29,14 +29,14 @@ mongoc_gridfs_file_readv (mongoc_gridfs_file_t *file,
       <tr><td><p>iov</p></td><td><p>An array of <code xref="mongoc_iovec_t">mongoc_iovec_t</code>.</p></td></tr>
       <tr><td><p>iovcnt</p></td><td><p>The number of elements in <code>iov</code>.</p></td></tr>
       <tr><td><p>min_bytes</p></td><td><p>The minimum number of bytes that must be read or an error will be synthesized.</p></td></tr>
-      <tr><td><p>timeout_msec</p></td><td><p>A uint32_t with the timeout in milliseconds.</p></td></tr>
+      <tr><td><p>timeout_msec</p></td><td><p>Unused.</p></td></tr>
     </table>
   </section>
 
   <section id="description">
     <title>Description</title>
     <p>This function performs a scattered read from <code>file</code>, potentially blocking to read from the MongoDB server.</p>
-    <p>Timeout should be the number of milliseconds to allow blocking, or 0 to disallow blocking.</p>
+    <p>The <code>timeout_msec</code> parameter is unused.</p>
   </section>
 
   <section id="return">

doc/mongoc_gridfs_file_writev.page

@@ -26,14 +26,14 @@ mongoc_gridfs_file_writev (mongoc_gridfs_file_t *file,
       <tr><td><p>file</p></td><td><p>A <code xref="mongoc_gridfs_file_t">mongoc_gridfs_file_t</code>.</p></td></tr>
       <tr><td><p>iov</p></td><td><p>An array of <code xref="mongoc_iovec_t">mongoc_iovec_t</code>.</p></td></tr>
       <tr><td><p>iovcnt</p></td><td><p>The number of elements in <code>iov</code>.</p></td></tr>
-      <tr><td><p>timeout_msec</p></td><td><p>A uint32_t with the timeout in milliseconds.</p></td></tr>
+      <tr><td><p>timeout_msec</p></td><td><p>Unused.</p></td></tr>
     </table>
   </section>
 
   <section id="description">
     <title>Description</title>
     <p>Performs a gathered write to the underlying gridfs file.</p>
-    <p>If timeout is reached, then -1 is returned and errno is set to ETIMEDOUT.</p>
+    <p>The <code>timeout_msec</code> parameter is unused.</p>
   </section>
 
   <section id="return">

src/mongoc/mongoc-gridfs-file.c

@@ -419,7 +419,8 @@ mongoc_gridfs_file_destroy (mongoc_gridfs_file_t *file)
 }
 
 
-/** readv against a gridfs file */
+/** readv against a gridfs file
+ *  timeout_msec is unused */
 ssize_t
 mongoc_gridfs_file_readv (mongoc_gridfs_file_t *file,
                           mongoc_iovec_t       *iov,
@@ -437,9 +438,6 @@ mongoc_gridfs_file_readv (mongoc_gridfs_file_t *file,
    BSON_ASSERT (file);
    BSON_ASSERT (iov);
    BSON_ASSERT (iovcnt);
-   BSON_ASSERT (timeout_msec <= INT_MAX);
-
-   /* TODO: we should probably do something about timeout_msec here */
 
    /* Reading when positioned past the end does nothing */
    if (file->pos >= file->length) {
@@ -484,7 +482,8 @@ mongoc_gridfs_file_readv (mongoc_gridfs_file_t *file,
 }
 
 
-/** writev against a gridfs file */
+/** writev against a gridfs file
+ *  timeout_msec is unused */
 ssize_t
 mongoc_gridfs_file_writev (mongoc_gridfs_file_t *file,
                            mongoc_iovec_t       *iov,
@@ -501,9 +500,6 @@ mongoc_gridfs_file_writev (mongoc_gridfs_file_t *file,
    BSON_ASSERT (file);
    BSON_ASSERT (iov);
    BSON_ASSERT (iovcnt);
-   BSON_ASSERT (timeout_msec <= INT_MAX);
-
-   /* TODO: we should probably do something about timeout_msec here */
 
    /* Pull in the correct page */
    if (!file->page && !_mongoc_gridfs_file_refresh_page (file)) {