Patchwork [03/11] man: Move "Mount option inheritance" section

login
register
mail settings
Submitter Chuck Lever
Date Jan. 10, 2014, 4:19 p.m.
Message ID <20140110161919.32524.42534.stgit@seurat.1015granger.net>
Download mbox | patch
Permalink /patch/309326/
State Accepted
Headers show

Comments

Chuck Lever - Jan. 10, 2014, 4:19 p.m.
The fedfs(7) man page contains a section discussing mount option
inheritance.  This level of detail belongs in the mount-specific
man pages, mount.fedfs(8) and fedfs-map-nfs4(8).

Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
---
 doc/man/fedfs-map-nfs4.8 |   32 +++++++++++++++++++++++++++++++-
 doc/man/fedfs.7          |   32 +-------------------------------
 doc/man/mount.fedfs.8    |   32 +++++++++++++++++++++++++++++++-
 3 files changed, 63 insertions(+), 33 deletions(-)

Patch

diff --git a/doc/man/fedfs-map-nfs4.8 b/doc/man/fedfs-map-nfs4.8
index ee6b394..3046605 100644
--- a/doc/man/fedfs-map-nfs4.8
+++ b/doc/man/fedfs-map-nfs4.8
@@ -5,7 +5,7 @@ 
 .\"
 
 .\"
-.\" Copyright 2011 Oracle.  All rights reserved.
+.\" Copyright 2011, 2013 Oracle.  All rights reserved.
 .\"
 .\" This file is part of fedfs-utils.
 .\"
@@ -130,6 +130,36 @@  a FedFS domain.
 Local applications browsing the top-level directory
 do not see all available FedFS domains.  They see only the ones that
 are mounted and active.
+.SS Mount option inheritance
+The Linux NFS client treats an NFS referral
+as a server-initiated mount request.
+The referring fileserver provides only a list of server names and export paths.
+The mount options for this new mount are inherited from the new mount
+point's parent directory on the client.
+.P
+As applications proceed deeper into a domain's namespace,
+they can encounter both file sets to which they have
+read-only access, and file sets to which they have read-write
+access.
+To allow applications proper access to both types of file sets,
+typically file-access clients mount domain root directories in read-write mode.
+All submounts of the domain root are then mounted read-write as well.
+Write access is controlled by fileservers.
+.P
+For example, a domain root may contain an NFS version 4 referral to an
+export containing user home directories.
+The domain root may be exported read-only so file-access clients cannot update it,
+but user home directories would not be very useful if they could not be
+written to by their owners.
+The fileserver continues to employ user credentials to limit access
+as appropriate.
+.P
+Network file system clients follow file system referrals
+as applications encounter them,
+which is similar to how an automounter works.
+Consider the initial mount of the domain root
+as if you are mounting a single whole file system,
+even though underneath, additional NFS mounts come and go as needed.
 .SH FILES
 .TP 18n
 .I /etc/auto.master
diff --git a/doc/man/fedfs.7 b/doc/man/fedfs.7
index 49d61f4..27769a0 100644
--- a/doc/man/fedfs.7
+++ b/doc/man/fedfs.7
@@ -5,7 +5,7 @@ 
 .\"
 
 .\"
-.\" Copyright 2011 Oracle.  All rights reserved.
+.\" Copyright 2011, 2013 Oracle.  All rights reserved.
 .\"
 .\" This file is part of fedfs-utils.
 .\"
@@ -194,36 +194,6 @@  or hide parts of the FedFS namespace for security purposes.
 However, it breaks cross-platform application interoperability
 by presenting applications with multiple pathnames to the same file object.
 Therefore it should be avoided.
-.SS Mount option inheritance
-The Linux NFS client treats an NFS referral
-as a server-initiated mount request.
-The referring fileserver provides only a list of server names and export paths.
-The mount options for this new mount are inherited from the new mount
-point’s parent directory on the client.
-.P
-As applications proceed deeper into a domain's namespace,
-they can encounter both file sets to which they have
-read-only access, and file sets to which they have read-write
-access.
-To allow applications proper access to both types of file sets,
-typically domain root directory's are mounted read-write on file-access clients.
-All submounts of the domain root are then mounted read-write as well, and
-write access is controlled by the fileservers.
-.P
-For example, a domain root may contain an NFS version 4 referral to an
-export containing user home directories.
-The domain root may be exported read-only so file-access clients cannot update it,
-but user home directories would not be very useful if they could not be
-written to by their owners.
-The fileserver continues to employ user credentials to limit access
-as appropriate.
-.P
-Network file system clients follow file system referrals
-as applications encounter them,
-which is similar to how an automounter works.
-Consider the initial mount of the domain root
-as if you are mounting a single whole file system,
-even though underneath, additional NFS mounts come and go as needed.
 .SS Creating domain roots
 NFSv4 FedFS domain roots are mounted via a standard export pathname.
 The first component of the domain root's export pathname is always
diff --git a/doc/man/mount.fedfs.8 b/doc/man/mount.fedfs.8
index 534f4ac..73558a7 100644
--- a/doc/man/mount.fedfs.8
+++ b/doc/man/mount.fedfs.8
@@ -5,7 +5,7 @@ 
 .\"
 
 .\"
-.\" Copyright 2011 Oracle.  All rights reserved.
+.\" Copyright 2011, 2013 Oracle.  All rights reserved.
 .\"
 .\" This file is part of fedfs-utils.
 .\"
@@ -93,6 +93,36 @@  is used for the actual mount operation,
 the file system's equivalent umount subcommand
 is all that is required to unmount this mount point when it is
 finished being used.
+.SS Mount option inheritance
+The Linux NFS client treats an NFS referral
+as a server-initiated mount request.
+The referring fileserver provides only a list of server names and export paths.
+The mount options for this new mount are inherited from the new mount
+point's parent directory on the client.
+.P
+As applications proceed deeper into a domain's namespace,
+they can encounter both file sets to which they have
+read-only access, and file sets to which they have read-write
+access.
+To allow applications proper access to both types of file sets,
+typically file-access clients mount domain root directories in read-write mode.
+All submounts of the domain root are then mounted read-write as well.
+Write access is then controlled by fileservers.
+.P
+For example, a domain root may contain an NFS version 4 referral to an
+export containing user home directories.
+The domain root may be exported read-only so file-access clients cannot update it,
+but user home directories would not be very useful if they could not be
+written to by their owners.
+The fileserver continues to employ user credentials to limit access
+as appropriate.
+.P
+Network file system clients follow file system referrals
+as applications encounter them,
+which is similar to how an automounter works.
+Consider the initial mount of the domain root
+as if you are mounting a single whole file system,
+even though underneath, additional NFS mounts come and go as needed.
 .SS Options
 .IP "\fB\-f, \-\-fake"
 Fake mount.  This option is ignored by