Documentation: update nfs option in filesystem/vfat.txt
authorNamjae Jeon <namjae.jeon@samsung.com>
Mon, 29 Apr 2013 23:21:15 +0000 (16:21 -0700)
committerLinus Torvalds <torvalds@linux-foundation.org>
Tue, 30 Apr 2013 01:28:41 +0000 (18:28 -0700)
Add descriptions about 'stale_rw' and 'nostale_ro' nfs options in
filesystem/vfat.txt

Signed-off-by: Namjae Jeon <namjae.jeon@samsung.com>
Signed-off-by: Ravishankar N <ravi.n1@samsung.com>
Signed-off-by: Amit Sahrawat <a.sahrawat@samsung.com>
Acked-by: OGAWA Hirofumi <hirofumi@mail.parknet.co.jp>
Acked-by: Rob Landley <rob@landley.net>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Documentation/filesystems/vfat.txt

index d230dd9c99b07bad6cbbc8cd9445b798188b8684..4a93e98b290a085793c495c9635b97335c58da56 100644 (file)
@@ -150,12 +150,28 @@ discard       -- If set, issues discard/TRIM commands to the block
                 device when blocks are freed. This is useful for SSD devices
                 and sparse/thinly-provisoned LUNs.
 
-nfs           -- This option maintains an index (cache) of directory
-                inodes by i_logstart which is used by the nfs-related code to
-                improve look-ups.
+nfs=stale_rw|nostale_ro
+               Enable this only if you want to export the FAT filesystem
+               over NFS.
+
+               stale_rw: This option maintains an index (cache) of directory
+               inodes by i_logstart which is used by the nfs-related code to
+               improve look-ups. Full file operations (read/write) over NFS is
+               supported but with cache eviction at NFS server, this could
+               result in ESTALE issues.
+
+               nostale_ro: This option bases the inode number and filehandle
+               on the on-disk location of a file in the MS-DOS directory entry.
+               This ensures that ESTALE will not be returned after a file is
+               evicted from the inode cache. However, it means that operations
+               such as rename, create and unlink could cause filehandles that
+               previously pointed at one file to point at a different file,
+               potentially causing data corruption. For this reason, this
+               option also mounts the filesystem readonly.
+
+               To maintain backward compatibility, '-o nfs' is also accepted,
+               defaulting to stale_rw
 
-                Enable this only if you want to export the FAT filesystem
-                over NFS
 
 <bool>: 0,1,yes,no,true,false