Provide documentation for autoreconnect option

Signed-off-by: Earl Chew <earl_chew@yahoo.com>
sahlberg · May 11, 2017 · ef8c67e · ef8c67e
1 parent 5e43d0a
commit ef8c67e
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/README b/README
@@ -44,6 +44,11 @@ Arguments supported by libnfs are :
                    : Should libnfs try to traverse across nested mounts
                      automatically or not. Default is 1 == enabled.
  dircache=<0|1>    : Disable/enable directory caching. Enabled by default.
+ autoreconnect=<0|1>
+                   : Disable/enable reconnection when connections close.
+                     When disabled, closed connections will cause an
+                     immediate error return, with loss of commands and
+                     data that are still inflight. Default is 1 == enabled.
  if=<interface>    : Interface name (e.g., eth1) to bind; requires `root`
 
 Auto_traverse_mounts

diff --git a/include/nfsc/libnfs.h b/include/nfsc/libnfs.h
@@ -182,6 +182,11 @@ EXTERN void nfs_destroy_context(struct nfs_context *nfs);
  *                   : Should libnfs try to traverse across nested mounts
  *                     automatically or not. Default is 1 == enabled.
  * dircache=<0|1>    : Disable/enable directory caching. Enabled by default.
+ * autoreconnect=<0|1>
+ *                   : Disable/enable reconnection when connections close.
+ *                     When disabled, closed connections will cause an
+ *                     immediate error return, with loss of commands and
+ *                     data that are still inflight. Default is 1 == enabled.
  */
 /*
  * Parse a complete NFS URL including, server, path and