Changes since last post:
        - added the information about the kernel CONFIG option
        - also added the information that caching is currently enabled for 
files opened as read-only

Document the newly added local caching feature using FS-Cache. This patch
could be queued and considered once the local caching patches gets merged
upstream.

Signed-off-by: Suresh Jayaraman <[email protected]>
---

 doc/mount.cifs.8.xml |   20 ++++++++++++++++++++
 1 files changed, 20 insertions(+), 0 deletions(-)

diff --git a/doc/mount.cifs.8.xml b/doc/mount.cifs.8.xml
index 4937550..af20c10 100644
--- a/doc/mount.cifs.8.xml
+++ b/doc/mount.cifs.8.xml
@@ -534,6 +534,26 @@ permissions in memory that can't be stored on the server. 
This information can d
                 maximum wsize currently allowed by CIFS is 57344 (fourteen
                 4096 byte pages)</para></listitem>
        </varlistentry>
+       <varlistentry>
+               <term>fsc</term>
+
+               <listitem><para>Enable local disk caching using FS-Cache
+               for cifs. This option could be useful to improve performance
+               on a slow link, heavily loaded server and/or network
+               where reading from the disk is faster than reading from the
+               server (over the network). This could also impact the
+               scalability positively as the number of calls to the server
+               are reduced. But, be warned that local caching is not suitable
+               for all workloads, for e.g., read-once type workloads. So
+               you need to consider carefully the situation/workload before
+               using this option. Currently, local disk caching is enabled
+               for CIFS files opened as read-only.
+               NOTE: This feature is available only in the recent kernels
+               that have been built with the kernel config option
+               CONFIG_CIFS_FSCACHE. You also need to have cachefilesd daemon
+               installed and running to make the cache operational.
+                </para></listitem>
+       </varlistentry>
         <varlistentry>
                 <term>--verbose</term>
                 <listitem><para>Print additional debugging information for the 
mount. Note that this parameter must be specified before the -o. For 
example:</para><para>mount -t cifs //server/share /mnt --verbose -o 
user=username</para></listitem>

--
To unsubscribe from this list: send the line "unsubscribe linux-cifs" in
the body of a message to [email protected]
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Reply via email to