Skip to content

Commit

Permalink
nfs: new subdir Documentation/filesystems/nfs
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
J. Bruce Fields committed Oct 27, 2009
1 parent e343eb0 commit dc7a081
Show file tree
Hide file tree
Showing 16 changed files with 27 additions and 21 deletions.
10 changes: 2 additions & 8 deletions Documentation/filesystems/00-INDEX
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
00-INDEX
- this file (info on some of the filesystems supported by linux).
Exporting
- explanation of how to make filesystems exportable.
Locking
- info on locking rules as they pertain to Linux VFS.
9p.txt
Expand Down Expand Up @@ -66,12 +64,8 @@ mandatory-locking.txt
- info on the Linux implementation of Sys V mandatory file locking.
ncpfs.txt
- info on Novell Netware(tm) filesystem using NCP protocol.
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.
nfs/
- nfs-related documentation.
nilfs2.txt
- info and mount options for the NILFS2 filesystem.
ntfs.txt
Expand Down
12 changes: 12 additions & 0 deletions Documentation/filesystems/nfs/00-INDEX
Original file line number Diff line number Diff line change
@@ -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.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion Documentation/filesystems/porting
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ Callers of notify_change() need ->i_mutex now.
New super_block field "struct export_operations *s_export_op" for
explicit support for exporting, e.g. via NFS. The structure is fully
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
to encode and decode filehandles, and allows the filesystem to use
Expand Down
6 changes: 3 additions & 3 deletions Documentation/kernel-parameters.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1017,7 +1017,7 @@ and is between 256 and 4096 characters. It is defined in the file
No delay

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
See comment before ip2_setup() in
Expand Down Expand Up @@ -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.

nfsaddrs= [NFS]
See Documentation/filesystems/nfsroot.txt.
See Documentation/filesystems/nfs/nfsroot.txt.

nfsroot= [NFS] nfs root filesystem for disk-less boxes.
See Documentation/filesystems/nfsroot.txt.
See Documentation/filesystems/nfs/nfsroot.txt.

nfs.callback_tcpport=
[NFS] set the TCP port on which the NFSv4 callback
Expand Down
2 changes: 1 addition & 1 deletion fs/cifs/export.c
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
*/

/*
* See Documentation/filesystems/Exporting
* See Documentation/filesystems/nfs/Exporting
* and examples in fs/exportfs
*
* Since cifs is a network file system, an "fsid" must be included for
Expand Down
2 changes: 1 addition & 1 deletion fs/exportfs/expfs.c
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
* and for mapping back from file handles to dentries.
*
* 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/fs.h>
Expand Down
2 changes: 1 addition & 1 deletion fs/isofs/export.c
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
*
* The following files are helpful:
*
* Documentation/filesystems/Exporting
* Documentation/filesystems/nfs/Exporting
* fs/exportfs/expfs.c.
*/

Expand Down
2 changes: 1 addition & 1 deletion fs/nfs/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ config ROOT_NFS
If you want your system to mount its root file system via NFS,
choose Y here. This is common practice for managing systems
without local permanent storage. For details, read
<file:Documentation/filesystems/nfsroot.txt>.
<file:Documentation/filesystems/nfs/nfsroot.txt>.

Most people say N here.

Expand Down
2 changes: 1 addition & 1 deletion include/linux/exportfs.h
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ struct fid {
* @get_name: find the name for a given inode in 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.
*
* encode_fh:
Expand Down
6 changes: 3 additions & 3 deletions net/ipv4/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ config IP_PNP_DHCP

If unsure, say Y. Note that if you want to use DHCP, a DHCP server
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
bool "IP: BOOTP support"
Expand All @@ -181,7 +181,7 @@ config IP_PNP_BOOTP
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
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
bool "IP: RARP support"
Expand All @@ -194,7 +194,7 @@ config IP_PNP_RARP
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
operating on your network. Read
<file:Documentation/filesystems/nfsroot.txt> for details.
<file:Documentation/filesystems/nfs/nfsroot.txt> for details.

# not yet ready..
# bool ' IP: ARP support' CONFIG_IP_PNP_ARP
Expand Down
2 changes: 1 addition & 1 deletion net/ipv4/ipconfig.c
Original file line number Diff line number Diff line change
Expand Up @@ -1447,7 +1447,7 @@ late_initcall(ip_auto_config);

/*
* 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)
{
Expand Down

0 comments on commit dc7a081

Please sign in to comment.