[PATCH] mount.nfs: Update description of clientaddr= in nfs(5)

[PATCH] mount.nfs: Update description of clientaddr= in nfs(5)

[Chuck Lever]

The description of clientaddr= in nfs(5) is out of date and omits some
other typical reasons for using it.  Let's start with this rewrite.

Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
---

 utils/mount/nfs.man |   13 +++++++++----
 1 files changed, 9 insertions(+), 4 deletions(-)

diff --git a/utils/mount/nfs.man b/utils/mount/nfs.man
index e66daba..6dd1603 100644
--- a/utils/mount/nfs.man
+++ b/utils/mount/nfs.man
@@ -412,10 +412,15 @@ and
 .IR tcp .
 .TP 1.5i
 .I clientaddr=n
-On a multi-homed client, this
-causes the client to use a specific callback address when
-communicating with an NFS version 4 server.
-This option is currently ignored.
+Specifies a single IPv4 address in dotted-quad form that the
+NFS client should advertise to a server for performing NFSv4
+callback requests for this mount point.
+If not specified, the mount command attempts to discover an
+appropriate callback address, then passes it to the NFS client.
+However, in the presence of multiple client network interfaces,
+special routing policies, or atypical network topologies, the
+exact address to use for callbacks may be difficult for the
+mount command to determine automatically.
 .TP 1.5i
 .I sec=mode
 Same as \f3sec=mode\f1 for the nfs filesystem type (see above).


-------------------------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc.
Still grepping through log files to find problems?  Stop.
Now Search log events and configuration files using AJAX and a browser.
Download your FREE copy of Splunk now >>  http://get.splunk.com/
_______________________________________________
NFS maillist  -  NFS@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/nfs

Re: [PATCH] mount.nfs: Update description of clientaddr= in nfs(5)

[J. Bruce Fields]

On Thu, Aug 30, 2007 at 03:48:10PM -0400, Chuck Lever wrote:
> +Specifies a single IPv4 address in dotted-quad form that the
> +NFS client should advertise to a server for performing NFSv4
> +callback requests for this mount point.
> +If not specified, the mount command attempts to discover an
> +appropriate callback address, then passes it to the NFS client.
> +However, in the presence of multiple client network interfaces,
> +special routing policies, or atypical network topologies, the
> +exact address to use for callbacks may be difficult for the
> +mount command to determine automatically.

Sounds good to me!

--b.

-------------------------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc.
Still grepping through log files to find problems?  Stop.
Now Search log events and configuration files using AJAX and a browser.
Download your FREE copy of Splunk now >>  http://get.splunk.com/
_______________________________________________
NFS maillist  -  NFS@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/nfs

Re: [PATCH] mount.nfs: Update description of clientaddr= in nfs(5)

[Gabriel Barazer]

On 08/30/2007 9:48:10 PM +0200, Chuck Lever <chuck.lever@oracle.com> wrote:
> The description of clientaddr= in nfs(5) is out of date and omits some
> other typical reasons for using it.  Let's start with this rewrite.
> 

By the way, can we update the man page date show the current version 
somewhere ? This is a bit disturbing to see "20 November 1993" at the 
bottom of the man page, and would clear minds about the "ignored at this 
time" or "not implemented yet" : does the word "currently" makes any 
sense, when the only date showed is 15 years ago ?

Gabriel

-------------------------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc.
Still grepping through log files to find problems?  Stop.
Now Search log events and configuration files using AJAX and a browser.
Download your FREE copy of Splunk now >>  http://get.splunk.com/
_______________________________________________
NFS maillist  -  NFS@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/nfs

Re: [PATCH] mount.nfs: Update description of clientaddr= in nfs(5)

[Talpey, Thomas]

At 03:48 PM 8/30/2007, Chuck Lever wrote:
>+Specifies a single IPv4 address in dotted-quad form that the
>+NFS client should advertise to a server for performing NFSv4

NFSv4 client. Just to be clear.

>+callback requests for this mount point.
>+If not specified, the mount command attempts to discover an
>+appropriate callback address, then passes it to the NFS client.

NFSv4 server. Passing it to the "client" just means "kernel".
Doesn't count until the server gets it. :-)

>+However, in the presence of multiple client network interfaces,
>+special routing policies, or atypical network topologies, the
>+exact address to use for callbacks may be difficult for the
>+mount command to determine automatically.

"Difficult" doesn't actually say what happens. Perhaps:

... atypical network topologies, the ...
"server may not be able to establish a connection to the
address supplied by the client to use for callbacks. This in turn
may lead to degraded client NFSv4 operation."

Or, is that language too ominous?

Tom.

-------------------------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc.
Still grepping through log files to find problems?  Stop.
Now Search log events and configuration files using AJAX and a browser.
Download your FREE copy of Splunk now >>  http://get.splunk.com/
_______________________________________________
NFS maillist  -  NFS@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/nfs

Re: [PATCH] mount.nfs: Update description of clientaddr= in nfs(5)

[Chuck Lever]

[-- Attachment #1: Type: text/plain, Size: 880 bytes --]

Gabriel Barazer wrote:
> On 08/30/2007 9:48:10 PM +0200, Chuck Lever <chuck.lever@oracle.com> wrote:
>> The description of clientaddr= in nfs(5) is out of date and omits some
>> other typical reasons for using it.  Let's start with this rewrite.
> 
> By the way, can we update the man page date show the current version 
> somewhere ? This is a bit disturbing to see "20 November 1993" at the 
> bottom of the man page, and would clear minds about the "ignored at this 
> time" or "not implemented yet" : does the word "currently" makes any 
> sense, when the only date showed is 15 years ago ?

As part of the new text-based mount work, I'm designing a complete 
replacement for nfs(5).  You can view a partially complete version of 
the new document here:

http://wiki.linux-nfs.org/wiki/index.php/NewNfsManPage

It's in the wiki so others can review, comment, and participate.

[-- Attachment #2: chuck.lever.vcf --]
[-- Type: text/x-vcard, Size: 290 bytes --]

begin:vcard
fn:Chuck Lever
n:Lever;Chuck
org:Oracle Corporation;Corporate Architecture: Linux Projects Group
adr:;;1015 Granger Avenue;Ann Arbor;MI;48104;USA
title:Principal Member of Staff
tel;work:+1 248 614 5091
x-mozilla-html:FALSE
url:http://oss.oracle.com/~cel
version:2.1
end:vcard


[-- Attachment #3: Type: text/plain, Size: 315 bytes --]

-------------------------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc.
Still grepping through log files to find problems?  Stop.
Now Search log events and configuration files using AJAX and a browser.
Download your FREE copy of Splunk now >>  http://get.splunk.com/

[-- Attachment #4: Type: text/plain, Size: 140 bytes --]

_______________________________________________
NFS maillist  -  NFS@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/nfs

Re: [PATCH] mount.nfs: Update description of clientaddr= in nfs(5)

[Chuck Lever]

[-- Attachment #1: Type: text/plain, Size: 683 bytes --]

Talpey, Thomas wrote:
> At 03:48 PM 8/30/2007, Chuck Lever wrote:
>> +However, in the presence of multiple client network interfaces,
>> +special routing policies, or atypical network topologies, the
>> +exact address to use for callbacks may be difficult for the
>> +mount command to determine automatically.
> 
> "Difficult" doesn't actually say what happens. Perhaps:
> 
> ... atypical network topologies, the ...
> "server may not be able to establish a connection to the
> address supplied by the client to use for callbacks. This in turn
> may lead to degraded client NFSv4 operation."

I think detailing the consequences a little is a good idea, so I'll try 
to work this in.

[-- Attachment #2: chuck.lever.vcf --]
[-- Type: text/x-vcard, Size: 290 bytes --]

begin:vcard
fn:Chuck Lever
n:Lever;Chuck
org:Oracle Corporation;Corporate Architecture: Linux Projects Group
adr:;;1015 Granger Avenue;Ann Arbor;MI;48104;USA
title:Principal Member of Staff
tel;work:+1 248 614 5091
x-mozilla-html:FALSE
url:http://oss.oracle.com/~cel
version:2.1
end:vcard


[-- Attachment #3: Type: text/plain, Size: 315 bytes --]

-------------------------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc.
Still grepping through log files to find problems?  Stop.
Now Search log events and configuration files using AJAX and a browser.
Download your FREE copy of Splunk now >>  http://get.splunk.com/

[-- Attachment #4: Type: text/plain, Size: 140 bytes --]

_______________________________________________
NFS maillist  -  NFS@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/nfs

[PATCH] mount.nfs: Update description of clientaddr= in nfs(5)

[Chuck Lever]

The description of clientaddr= in nfs(5) is out of date and omits some
other typical reasons for using it.  Expand the description.

Rewrite, take 2.  This may address review comments..?

Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
---

 utils/mount/nfs.man |   19 +++++++++++++++----
 1 files changed, 15 insertions(+), 4 deletions(-)

diff --git a/utils/mount/nfs.man b/utils/mount/nfs.man
index e66daba..7248099 100644
--- a/utils/mount/nfs.man
+++ b/utils/mount/nfs.man
@@ -412,10 +412,21 @@ and
 .IR tcp .
 .TP 1.5i
 .I clientaddr=n
-On a multi-homed client, this
-causes the client to use a specific callback address when
-communicating with an NFS version 4 server.
-This option is currently ignored.
+Specifies a single IPv4 address in dotted-quad form that
+the NFS client advertises to allow servers to perform
+NFSv4 callback requests against files on this mount point.
+If the server is not able to establish callback connections
+to clients, performance may degrade, or accesses to
+files may temporarily hang.
+.IP
+If this option is not specified, the
+.BR mount (8)
+command attempts to discover an appropriate callback
+address automatically.
+The automatic discovery process is not perfect, however.
+In the presence of multiple client network interfaces, special
+routing policies, or atypical network topologies, the exact
+address to use for callbacks may be nontrivial to determine.
 .TP 1.5i
 .I sec=mode
 Same as \f3sec=mode\f1 for the nfs filesystem type (see above).


-------------------------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc.
Still grepping through log files to find problems?  Stop.
Now Search log events and configuration files using AJAX and a browser.
Download your FREE copy of Splunk now >>  http://get.splunk.com/
_______________________________________________
NFS maillist  -  NFS@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/nfs