diff mbox

mount.cifs: document 'fsc' mount option

Message ID 4C4F0DCA.2010604@suse.de (mailing list archive)
State New, archived
Headers show

Commit Message

Suresh Jayaraman July 27, 2010, 4:48 p.m. UTC
None
diff mbox

Patch

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>