diff options
author | Christoph Hellwig <hch@lst.de> | 2007-10-21 19:42:19 -0400 |
---|---|---|
committer | Linus Torvalds <torvalds@woody.linux-foundation.org> | 2007-10-22 11:13:21 -0400 |
commit | e38f981758118d829cd40cfe9c09e3fa81e422aa (patch) | |
tree | 73a071109999b31697925ca7a4336f3d4beeef21 /include | |
parent | 39655164405940d4818224a085e35420e2f97aed (diff) |
exportfs: update documentation
Update documentation to the current state of affairs. Remove duplicated
method descruptions in exportfs.h and point to Documentation/filesystems/
Exporting instead. Add a little file header comment in expfs.c describing
what's going on and mentioning Neils and my copyright [1].
Signed-off-by: Christoph Hellwig <hch@lst.de>
Cc: Neil Brown <neilb@suse.de>
Cc: "J. Bruce Fields" <bfields@fieldses.org>
Cc: <linux-ext4@vger.kernel.org>
Cc: Dave Kleikamp <shaggy@austin.ibm.com>
Cc: Anton Altaparmakov <aia21@cantab.net>
Cc: David Chinner <dgc@sgi.com>
Cc: Timothy Shimmin <tes@sgi.com>
Cc: OGAWA Hirofumi <hirofumi@mail.parknet.co.jp>
Cc: Hugh Dickins <hugh@veritas.com>
Cc: Chris Mason <mason@suse.com>
Cc: Jeff Mahoney <jeffm@suse.com>
Cc: "Vladimir V. Saveliev" <vs@namesys.com>
Cc: Steven Whitehouse <swhiteho@redhat.com>
Cc: Mark Fasheh <mark.fasheh@oracle.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Diffstat (limited to 'include')
-rw-r--r-- | include/linux/exportfs.h | 26 |
1 files changed, 2 insertions, 24 deletions
diff --git a/include/linux/exportfs.h b/include/linux/exportfs.h index 0b4a771b4903..51d214138814 100644 --- a/include/linux/exportfs.h +++ b/include/linux/exportfs.h | |||
@@ -55,30 +55,8 @@ struct fid { | |||
55 | * @get_parent: find the parent of a given directory | 55 | * @get_parent: find the parent of a given directory |
56 | * @get_dentry: find a dentry for the inode given a file handle sub-fragment | 56 | * @get_dentry: find a dentry for the inode given a file handle sub-fragment |
57 | * | 57 | * |
58 | * Description: | 58 | * See Documentation/filesystems/Exporting for details on how to use |
59 | * The export_operations structure provides a means for nfsd to communicate | 59 | * this interface correctly. |
60 | * with a particular exported file system - particularly enabling nfsd and | ||
61 | * the filesystem to co-operate when dealing with file handles. | ||
62 | * | ||
63 | * export_operations contains two basic operation for dealing with file | ||
64 | * handles, decode_fh() and encode_fh(), and allows for some other | ||
65 | * operations to be defined which standard helper routines use to get | ||
66 | * specific information from the filesystem. | ||
67 | * | ||
68 | * nfsd encodes information use to determine which filesystem a filehandle | ||
69 | * applies to in the initial part of the file handle. The remainder, termed | ||
70 | * a file handle fragment, is controlled completely by the filesystem. The | ||
71 | * standard helper routines assume that this fragment will contain one or | ||
72 | * two sub-fragments, one which identifies the file, and one which may be | ||
73 | * used to identify the (a) directory containing the file. | ||
74 | * | ||
75 | * In some situations, nfsd needs to get a dentry which is connected into a | ||
76 | * specific part of the file tree. To allow for this, it passes the | ||
77 | * function acceptable() together with a @context which can be used to see | ||
78 | * if the dentry is acceptable. As there can be multiple dentrys for a | ||
79 | * given file, the filesystem should check each one for acceptability before | ||
80 | * looking for the next. As soon as an acceptable one is found, it should | ||
81 | * be returned. | ||
82 | * | 60 | * |
83 | * encode_fh: | 61 | * encode_fh: |
84 | * @encode_fh should store in the file handle fragment @fh (using at most | 62 | * @encode_fh should store in the file handle fragment @fh (using at most |