DOCS: document the readahead url argument

Signed-off-by: Ronnie Sahlberg <ronniesahlberg@gmail.com>
sahlberg · Dec 5, 2014 · 9c1d384 · 9c1d384
1 parent 5f6442d
commit 9c1d384
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/README b/README
@@ -38,7 +38,8 @@ Arguments supported by libnfs are :
                      default it 65534 on Windows and getuid() on unixen.
  gid=<int>         : GID value to use when talking to the server.
                      default it 65534 on Windows and getgid() on unixen.
-
+ readahead=<int>   : Enable readahead for files and set the maximum amount
+                     of readahead to <int>.
 
 ROOT vs NON-ROOT
 ================

diff --git a/include/nfsc/libnfs.h b/include/nfsc/libnfs.h
@@ -142,6 +142,8 @@ EXTERN void nfs_destroy_context(struct nfs_context *nfs);
  *                     default it 65534 on Windows and getuid() on unixen.
  * gid=<int>         : GID value to use when talking to the server.
  *                     default it 65534 on Windows and getgid() on unixen.
+ * readahead=<int>   : Enable readahead for files and set the maximum amount
+ *                     of readahead to <int>.
  */
 /*
  * Parse a complete NFS URL including, server, path and