nfs: new subdir Documentation/filesystems/nfs

We're adding enough nfs documentation that it may as well have its own
subdirectory.

Acked-by: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
This commit is contained in:
J. Bruce Fields 2009-10-27 14:41:35 -04:00
parent e343eb0d60
commit dc7a08166f
16 changed files with 27 additions and 21 deletions

View file

@ -1,7 +1,5 @@
00-INDEX 00-INDEX
- this file (info on some of the filesystems supported by linux). - this file (info on some of the filesystems supported by linux).
Exporting
- explanation of how to make filesystems exportable.
Locking Locking
- info on locking rules as they pertain to Linux VFS. - info on locking rules as they pertain to Linux VFS.
9p.txt 9p.txt
@ -66,12 +64,8 @@ mandatory-locking.txt
- info on the Linux implementation of Sys V mandatory file locking. - info on the Linux implementation of Sys V mandatory file locking.
ncpfs.txt ncpfs.txt
- info on Novell Netware(tm) filesystem using NCP protocol. - info on Novell Netware(tm) filesystem using NCP protocol.
nfs41-server.txt nfs/
- info on the Linux server implementation of NFSv4 minor version 1. - nfs-related documentation.
nfs-rdma.txt
- how to install and setup the Linux NFS/RDMA client and server software.
nfsroot.txt
- short guide on setting up a diskless box with NFS root filesystem.
nilfs2.txt nilfs2.txt
- info and mount options for the NILFS2 filesystem. - info and mount options for the NILFS2 filesystem.
ntfs.txt ntfs.txt

View file

@ -0,0 +1,12 @@
00-INDEX
- this file (nfs-related documentation).
Exporting
- explanation of how to make filesystems exportable.
nfs.txt
- nfs client, and DNS resolution for fs_locations.
nfs41-server.txt
- info on the Linux server implementation of NFSv4 minor version 1.
nfs-rdma.txt
- how to install and setup the Linux NFS/RDMA client and server software
nfsroot.txt
- short guide on setting up a diskless box with NFS root filesystem.

View file

@ -140,7 +140,7 @@ Callers of notify_change() need ->i_mutex now.
New super_block field "struct export_operations *s_export_op" for New super_block field "struct export_operations *s_export_op" for
explicit support for exporting, e.g. via NFS. The structure is fully explicit support for exporting, e.g. via NFS. The structure is fully
documented at its declaration in include/linux/fs.h, and in documented at its declaration in include/linux/fs.h, and in
Documentation/filesystems/Exporting. Documentation/filesystems/nfs/Exporting.
Briefly it allows for the definition of decode_fh and encode_fh operations Briefly it allows for the definition of decode_fh and encode_fh operations
to encode and decode filehandles, and allows the filesystem to use to encode and decode filehandles, and allows the filesystem to use

View file

@ -1017,7 +1017,7 @@ and is between 256 and 4096 characters. It is defined in the file
No delay No delay
ip= [IP_PNP] ip= [IP_PNP]
See Documentation/filesystems/nfsroot.txt. See Documentation/filesystems/nfs/nfsroot.txt.
ip2= [HW] Set IO/IRQ pairs for up to 4 IntelliPort boards ip2= [HW] Set IO/IRQ pairs for up to 4 IntelliPort boards
See comment before ip2_setup() in See comment before ip2_setup() in
@ -1538,10 +1538,10 @@ and is between 256 and 4096 characters. It is defined in the file
going to be removed in 2.6.29. going to be removed in 2.6.29.
nfsaddrs= [NFS] nfsaddrs= [NFS]
See Documentation/filesystems/nfsroot.txt. See Documentation/filesystems/nfs/nfsroot.txt.
nfsroot= [NFS] nfs root filesystem for disk-less boxes. nfsroot= [NFS] nfs root filesystem for disk-less boxes.
See Documentation/filesystems/nfsroot.txt. See Documentation/filesystems/nfs/nfsroot.txt.
nfs.callback_tcpport= nfs.callback_tcpport=
[NFS] set the TCP port on which the NFSv4 callback [NFS] set the TCP port on which the NFSv4 callback

View file

@ -24,7 +24,7 @@
*/ */
/* /*
* See Documentation/filesystems/Exporting * See Documentation/filesystems/nfs/Exporting
* and examples in fs/exportfs * and examples in fs/exportfs
* *
* Since cifs is a network file system, an "fsid" must be included for * Since cifs is a network file system, an "fsid" must be included for

View file

@ -6,7 +6,7 @@
* and for mapping back from file handles to dentries. * and for mapping back from file handles to dentries.
* *
* For details on why we do all the strange and hairy things in here * For details on why we do all the strange and hairy things in here
* take a look at Documentation/filesystems/Exporting. * take a look at Documentation/filesystems/nfs/Exporting.
*/ */
#include <linux/exportfs.h> #include <linux/exportfs.h>
#include <linux/fs.h> #include <linux/fs.h>

View file

@ -9,7 +9,7 @@
* *
* The following files are helpful: * The following files are helpful:
* *
* Documentation/filesystems/Exporting * Documentation/filesystems/nfs/Exporting
* fs/exportfs/expfs.c. * fs/exportfs/expfs.c.
*/ */

View file

@ -90,7 +90,7 @@ config ROOT_NFS
If you want your system to mount its root file system via NFS, If you want your system to mount its root file system via NFS,
choose Y here. This is common practice for managing systems choose Y here. This is common practice for managing systems
without local permanent storage. For details, read without local permanent storage. For details, read
<file:Documentation/filesystems/nfsroot.txt>. <file:Documentation/filesystems/nfs/nfsroot.txt>.
Most people say N here. Most people say N here.

View file

@ -97,7 +97,7 @@ struct fid {
* @get_name: find the name for a given inode in a given directory * @get_name: find the name for a given inode in a given directory
* @get_parent: find the parent of a given directory * @get_parent: find the parent of a given directory
* *
* See Documentation/filesystems/Exporting for details on how to use * See Documentation/filesystems/nfs/Exporting for details on how to use
* this interface correctly. * this interface correctly.
* *
* encode_fh: * encode_fh:

View file

@ -166,7 +166,7 @@ config IP_PNP_DHCP
If unsure, say Y. Note that if you want to use DHCP, a DHCP server If unsure, say Y. Note that if you want to use DHCP, a DHCP server
must be operating on your network. Read must be operating on your network. Read
<file:Documentation/filesystems/nfsroot.txt> for details. <file:Documentation/filesystems/nfs/nfsroot.txt> for details.
config IP_PNP_BOOTP config IP_PNP_BOOTP
bool "IP: BOOTP support" bool "IP: BOOTP support"
@ -181,7 +181,7 @@ config IP_PNP_BOOTP
does BOOTP itself, providing all necessary information on the kernel does BOOTP itself, providing all necessary information on the kernel
command line, you can say N here. If unsure, say Y. Note that if you command line, you can say N here. If unsure, say Y. Note that if you
want to use BOOTP, a BOOTP server must be operating on your network. want to use BOOTP, a BOOTP server must be operating on your network.
Read <file:Documentation/filesystems/nfsroot.txt> for details. Read <file:Documentation/filesystems/nfs/nfsroot.txt> for details.
config IP_PNP_RARP config IP_PNP_RARP
bool "IP: RARP support" bool "IP: RARP support"
@ -194,7 +194,7 @@ config IP_PNP_RARP
older protocol which is being obsoleted by BOOTP and DHCP), say Y older protocol which is being obsoleted by BOOTP and DHCP), say Y
here. Note that if you want to use RARP, a RARP server must be here. Note that if you want to use RARP, a RARP server must be
operating on your network. Read operating on your network. Read
<file:Documentation/filesystems/nfsroot.txt> for details. <file:Documentation/filesystems/nfs/nfsroot.txt> for details.
# not yet ready.. # not yet ready..
# bool ' IP: ARP support' CONFIG_IP_PNP_ARP # bool ' IP: ARP support' CONFIG_IP_PNP_ARP

View file

@ -1447,7 +1447,7 @@ late_initcall(ip_auto_config);
/* /*
* Decode any IP configuration options in the "ip=" or "nfsaddrs=" kernel * Decode any IP configuration options in the "ip=" or "nfsaddrs=" kernel
* command line parameter. See Documentation/filesystems/nfsroot.txt. * command line parameter. See Documentation/filesystems/nfs/nfsroot.txt.
*/ */
static int __init ic_proto_name(char *name) static int __init ic_proto_name(char *name)
{ {