diff mbox

nfs(5): Document the minorversion= mount option

Message ID 20121114223600.48062.5680.stgit@seurat.1015granger.net (mailing list archive)
State New, archived
Headers show

Commit Message

Chuck Lever Nov. 14, 2012, 10:39 p.m. UTC 
Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
---

Our pals on the Solaris team recently noticed that the minorversion=
option is not documented in nfs(5).  This is a first take, just to
start the conversation.  I'm pretty sure I got the kernel version
information wrong, for instance.

Any other comments?

 utils/mount/nfs.man |   17 +++++++++++++++++
 1 files changed, 17 insertions(+), 0 deletions(-)


--
To unsubscribe from this list: send the line "unsubscribe linux-nfs" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Comments

Trond Myklebust Nov. 14, 2012, 11:01 p.m. UTC | #1 
> -----Original Message-----

> From: linux-nfs-owner@vger.kernel.org [mailto:linux-nfs-

> owner@vger.kernel.org] On Behalf Of Chuck Lever

> Sent: Wednesday, November 14, 2012 5:39 PM

> To: linux-nfs@vger.kernel.org

> Subject: [PATCH] nfs(5): Document the minorversion= mount option

> 

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

> ---

> 

> Our pals on the Solaris team recently noticed that the minorversion= option

> is not documented in nfs(5).  This is a first take, just to start the conversation.

> I'm pretty sure I got the kernel version information wrong, for instance.

> 

> Any other comments?


You might want to note that it is deprecated in favour of the "vers=4.1" notation, and for that reason we might want to forgo documenting it altogether.

>  utils/mount/nfs.man |   17 +++++++++++++++++

>  1 files changed, 17 insertions(+), 0 deletions(-)

> 

> diff --git a/utils/mount/nfs.man b/utils/mount/nfs.man index

> c15de98..66198cc 100644

> --- a/utils/mount/nfs.man

> +++ b/utils/mount/nfs.man

> @@ -777,6 +777,23 @@ so if this mount option is not specified, the NFS

> version 4 client  uses the TCP protocol.

>  Refer to the TRANSPORT METHODS section for more details.

>  .TP 1.5i

> +.BI minorversion= n

> +Specifies the protocol minor version number.

> +NFSv4 introduces "minor versioning," where NFS protocol enhancements

> +can be introduced without bumping the NFS protocol version number.

> +Before kernel 2.6.38, the minor version is always zero, and this option

> +is not recognized.

> +After this kernel, specifying "minorversion=1" enables a number of

> +advanced features, such as NFSv4 sessions.

> +.IP

> +Recent kernels allow the minor version to be specified using the .B

> +vers= option.

> +For example, specifying

> +.B vers=4.1

> +is the same as specifying

> +.BR vers=4,minorversion=1 .

> +.TP 1.5i

>  .BI port= n

>  The numeric value of the server's NFS service port.

>  If the server's NFS service is not available on the specified port,

> 

> --

> To unsubscribe from this list: send the line "unsubscribe linux-nfs" in the

> body of a message to majordomo@vger.kernel.org More majordomo info at

> http://vger.kernel.org/majordomo-info.html
Chuck Lever Nov. 14, 2012, 11:03 p.m. UTC | #2 
On Nov 14, 2012, at 6:01 PM, "Myklebust, Trond" <Trond.Myklebust@netapp.com> wrote:

>> -----Original Message-----
>> From: linux-nfs-owner@vger.kernel.org [mailto:linux-nfs-
>> owner@vger.kernel.org] On Behalf Of Chuck Lever
>> Sent: Wednesday, November 14, 2012 5:39 PM
>> To: linux-nfs@vger.kernel.org
>> Subject: [PATCH] nfs(5): Document the minorversion= mount option
>> 
>> Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
>> ---
>> 
>> Our pals on the Solaris team recently noticed that the minorversion= option
>> is not documented in nfs(5).  This is a first take, just to start the conversation.
>> I'm pretty sure I got the kernel version information wrong, for instance.
>> 
>> Any other comments?
> 
> You might want to note that it is deprecated in favour of the "vers=4.1" notation, and for that reason we might want to forgo documenting it altogether.

OK.  minorversion= is the only way to get NFSv4.1 on EL6-based distributions, isn't it?

By "deprecated" do you mean that you intend to remove it?

> 
>> utils/mount/nfs.man |   17 +++++++++++++++++
>> 1 files changed, 17 insertions(+), 0 deletions(-)
>> 
>> diff --git a/utils/mount/nfs.man b/utils/mount/nfs.man index
>> c15de98..66198cc 100644
>> --- a/utils/mount/nfs.man
>> +++ b/utils/mount/nfs.man
>> @@ -777,6 +777,23 @@ so if this mount option is not specified, the NFS
>> version 4 client  uses the TCP protocol.
>> Refer to the TRANSPORT METHODS section for more details.
>> .TP 1.5i
>> +.BI minorversion= n
>> +Specifies the protocol minor version number.
>> +NFSv4 introduces "minor versioning," where NFS protocol enhancements
>> +can be introduced without bumping the NFS protocol version number.
>> +Before kernel 2.6.38, the minor version is always zero, and this option
>> +is not recognized.
>> +After this kernel, specifying "minorversion=1" enables a number of
>> +advanced features, such as NFSv4 sessions.
>> +.IP
>> +Recent kernels allow the minor version to be specified using the .B
>> +vers= option.
>> +For example, specifying
>> +.B vers=4.1
>> +is the same as specifying
>> +.BR vers=4,minorversion=1 .
>> +.TP 1.5i
>> .BI port= n
>> The numeric value of the server's NFS service port.
>> If the server's NFS service is not available on the specified port,
>> 
>> --
>> To unsubscribe from this list: send the line "unsubscribe linux-nfs" in the
>> body of a message to majordomo@vger.kernel.org More majordomo info at
>> http://vger.kernel.org/majordomo-info.html--
> To unsubscribe from this list: send the line "unsubscribe linux-nfs" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
>
Trond Myklebust Nov. 14, 2012, 11:12 p.m. UTC | #3 
T24gV2VkLCAyMDEyLTExLTE0IGF0IDE4OjAzIC0wNTAwLCBDaHVjayBMZXZlciB3cm90ZToNCj4g
T24gTm92IDE0LCAyMDEyLCBhdCA2OjAxIFBNLCAiTXlrbGVidXN0LCBUcm9uZCIgPFRyb25kLk15
a2xlYnVzdEBuZXRhcHAuY29tPiB3cm90ZToNCj4gDQo+ID4+IC0tLS0tT3JpZ2luYWwgTWVzc2Fn
ZS0tLS0tDQo+ID4+IEZyb206IGxpbnV4LW5mcy1vd25lckB2Z2VyLmtlcm5lbC5vcmcgW21haWx0
bzpsaW51eC1uZnMtDQo+ID4+IG93bmVyQHZnZXIua2VybmVsLm9yZ10gT24gQmVoYWxmIE9mIENo
dWNrIExldmVyDQo+ID4+IFNlbnQ6IFdlZG5lc2RheSwgTm92ZW1iZXIgMTQsIDIwMTIgNTozOSBQ
TQ0KPiA+PiBUbzogbGludXgtbmZzQHZnZXIua2VybmVsLm9yZw0KPiA+PiBTdWJqZWN0OiBbUEFU
Q0hdIG5mcyg1KTogRG9jdW1lbnQgdGhlIG1pbm9ydmVyc2lvbj0gbW91bnQgb3B0aW9uDQo+ID4+
IA0KPiA+PiBTaWduZWQtb2ZmLWJ5OiBDaHVjayBMZXZlciA8Y2h1Y2subGV2ZXJAb3JhY2xlLmNv
bT4NCj4gPj4gLS0tDQo+ID4+IA0KPiA+PiBPdXIgcGFscyBvbiB0aGUgU29sYXJpcyB0ZWFtIHJl
Y2VudGx5IG5vdGljZWQgdGhhdCB0aGUgbWlub3J2ZXJzaW9uPSBvcHRpb24NCj4gPj4gaXMgbm90
IGRvY3VtZW50ZWQgaW4gbmZzKDUpLiAgVGhpcyBpcyBhIGZpcnN0IHRha2UsIGp1c3QgdG8gc3Rh
cnQgdGhlIGNvbnZlcnNhdGlvbi4NCj4gPj4gSSdtIHByZXR0eSBzdXJlIEkgZ290IHRoZSBrZXJu
ZWwgdmVyc2lvbiBpbmZvcm1hdGlvbiB3cm9uZywgZm9yIGluc3RhbmNlLg0KPiA+PiANCj4gPj4g
QW55IG90aGVyIGNvbW1lbnRzPw0KPiA+IA0KPiA+IFlvdSBtaWdodCB3YW50IHRvIG5vdGUgdGhh
dCBpdCBpcyBkZXByZWNhdGVkIGluIGZhdm91ciBvZiB0aGUgInZlcnM9NC4xIiBub3RhdGlvbiwg
YW5kIGZvciB0aGF0IHJlYXNvbiB3ZSBtaWdodCB3YW50IHRvIGZvcmdvIGRvY3VtZW50aW5nIGl0
IGFsdG9nZXRoZXIuDQo+IA0KPiBPSy4gIG1pbm9ydmVyc2lvbj0gaXMgdGhlIG9ubHkgd2F5IHRv
IGdldCBORlN2NC4xIG9uIEVMNi1iYXNlZCBkaXN0cmlidXRpb25zLCBpc24ndCBpdD8NCg0KWW91
IGRpZG4ndCBzZWVtIHRvIGJlIHdyaXRpbmcgYSBtYW5wYWdlIGZvciB0aGUgUkhFTC02IGRpc3Ry
b3M6ICJCZWZvcmUNCmtlcm5lbCAyLjYuMzgsIHRoZSBtaW5vciB2ZXJzaW9uIGlzIGFsd2F5cyB6
ZXJvLi4uIi4gQXMgZmFyIGFzIEkga25vdywNClJIRUwtNiBpcyBzdGlsbCBiYXNlZCBvbiAyLjYu
MzIuLi4NCg0KPiBCeSAiZGVwcmVjYXRlZCIgZG8geW91IG1lYW4gdGhhdCB5b3UgaW50ZW5kIHRv
IHJlbW92ZSBpdD8NCg0KSSBtZWFuIGZvciBpbnN0YW5jZSB0aGF0ICdjYXQgL3Byb2MvbW91bnRz
JyBhbmQgZnJpZW5kcyB3aWxsIHVzZSB0aGUNCid2ZXJzPTQuMScgbm90YXRpb24uIFRoZXkgd29u
J3QgZXZlciBkaXNwbGF5ICdtaW5vcnZlcnNpb249Jy4NCg0KV2UgbWF5IGVuZCB1cCByZW1vdmlu
ZyBzdXBwb3J0IGZvciBpdCBzb21lIGRheS4NCg0KLS0gDQpUcm9uZCBNeWtsZWJ1c3QNCkxpbnV4
IE5GUyBjbGllbnQgbWFpbnRhaW5lcg0KDQpOZXRBcHANClRyb25kLk15a2xlYnVzdEBuZXRhcHAu
Y29tDQp3d3cubmV0YXBwLmNvbQ0K
--
To unsubscribe from this list: send the line "unsubscribe linux-nfs" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Chuck Lever Nov. 14, 2012, 11:37 p.m. UTC | #4 
On Nov 14, 2012, at 6:12 PM, "Myklebust, Trond" <Trond.Myklebust@netapp.com> wrote:

> On Wed, 2012-11-14 at 18:03 -0500, Chuck Lever wrote:
>> On Nov 14, 2012, at 6:01 PM, "Myklebust, Trond" <Trond.Myklebust@netapp.com> wrote:
>> 
>>>> -----Original Message-----
>>>> From: linux-nfs-owner@vger.kernel.org [mailto:linux-nfs-
>>>> owner@vger.kernel.org] On Behalf Of Chuck Lever
>>>> Sent: Wednesday, November 14, 2012 5:39 PM
>>>> To: linux-nfs@vger.kernel.org
>>>> Subject: [PATCH] nfs(5): Document the minorversion= mount option
>>>> 
>>>> Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
>>>> ---
>>>> 
>>>> Our pals on the Solaris team recently noticed that the minorversion= option
>>>> is not documented in nfs(5).  This is a first take, just to start the conversation.
>>>> I'm pretty sure I got the kernel version information wrong, for instance.
>>>> 
>>>> Any other comments?
>>> 
>>> You might want to note that it is deprecated in favour of the "vers=4.1" notation, and for that reason we might want to forgo documenting it altogether.
>> 
>> OK.  minorversion= is the only way to get NFSv4.1 on EL6-based distributions, isn't it?
> 
> You didn't seem to be writing a manpage for the RHEL-6 distros: "Before
> kernel 2.6.38, the minor version is always zero...". As far as I know,
> RHEL-6 is still based on 2.6.32...

...for some very loose definition of "based on".  One wonders how to document kernel versions in this instance.  One way to fix this is to have RH patch their copy of nfs(5) privately, while upstream nfs-utils can handle this in some other way.

However, search for "Parallel NFS" on this page:

  https://access.redhat.com/knowledge/docs/en-US/Red_Hat_Enterprise_Linux/6/html-single/6.2_Release_Notes/index.html

This seems to me to count as public documentation of "minorversion=", and suggests that people are likely already using this formal API.  I would hesitate to remove it in this instance.
Steve Dickson Nov. 16, 2012, 1:39 p.m. UTC | #5 
Hey Chuck,

First of all, thanks for point this out... 

On 14/11/12 18:37, Chuck Lever wrote:
> 
> On Nov 14, 2012, at 6:12 PM, "Myklebust, Trond" <Trond.Myklebust@netapp.com> wrote:
> 
>> On Wed, 2012-11-14 at 18:03 -0500, Chuck Lever wrote:
>>> On Nov 14, 2012, at 6:01 PM, "Myklebust, Trond" <Trond.Myklebust@netapp.com> wrote:
>>>
>>>>> -----Original Message-----
>>>>> From: linux-nfs-owner@vger.kernel.org [mailto:linux-nfs-
>>>>> owner@vger.kernel.org] On Behalf Of Chuck Lever
>>>>> Sent: Wednesday, November 14, 2012 5:39 PM
>>>>> To: linux-nfs@vger.kernel.org
>>>>> Subject: [PATCH] nfs(5): Document the minorversion= mount option
>>>>>
>>>>> Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
>>>>> ---
>>>>>
>>>>> Our pals on the Solaris team recently noticed that the minorversion= option
>>>>> is not documented in nfs(5).  This is a first take, just to start the conversation.
>>>>> I'm pretty sure I got the kernel version information wrong, for instance.
>>>>>
>>>>> Any other comments?
>>>>
>>>> You might want to note that it is deprecated in favour of the "vers=4.1" notation, and for that reason we might want to forgo documenting it altogether.
>>>
>>> OK.  minorversion= is the only way to get NFSv4.1 on EL6-based distributions, isn't it?
>>
>> You didn't seem to be writing a manpage for the RHEL-6 distros: "Before
>> kernel 2.6.38, the minor version is always zero...". As far as I know,
>> RHEL-6 is still based on 2.6.32...
2.6.32 is where we made the branch. So it accurate to say RHEL6 is based
on 2.6.36, but in reality it absolutely not a straight 2.6.32 upstream 
kernel due to all the backporting we do.  

> 
> ...for some very loose definition of "based on".  One wonders how to document kernel versions in this instance.  One way to fix this is to have RH patch their copy of nfs(5) privately, while upstream nfs-utils can handle this in some other way.
Yeah, We'll have to carry an private patch that updates the man page. 

> 
> However, search for "Parallel NFS" on this page:
> 
>   https://access.redhat.com/knowledge/docs/en-US/Red_Hat_Enterprise_Linux/6/html-single/6.2_Release_Notes/index.html
> 
> This seems to me to count as public documentation of "minorversion=", and suggests that people are likely already using this formal API.  I would hesitate to remove it in this instance.
> 
If upstream wants to deprecate minorversion= than so be it... That will have
little effect on a RHEL release since we can't change the API like that... 

steved.
--
To unsubscribe from this list: send the line "unsubscribe linux-nfs" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Chuck Lever Nov. 16, 2012, 2:05 p.m. UTC | #6 
For the record I opened RH bugzilla 877052 yesterday to document this issue in RHEL 6.

Sent from my iPhone

On Nov 16, 2012, at 8:39 AM, Steve Dickson <SteveD@redhat.com> wrote:

> Hey Chuck,
> 
> First of all, thanks for point this out... 
> 
> On 14/11/12 18:37, Chuck Lever wrote:
>> 
>> On Nov 14, 2012, at 6:12 PM, "Myklebust, Trond" <Trond.Myklebust@netapp.com> wrote:
>> 
>>> On Wed, 2012-11-14 at 18:03 -0500, Chuck Lever wrote:
>>>> On Nov 14, 2012, at 6:01 PM, "Myklebust, Trond" <Trond.Myklebust@netapp.com> wrote:
>>>> 
>>>>>> -----Original Message-----
>>>>>> From: linux-nfs-owner@vger.kernel.org [mailto:linux-nfs-
>>>>>> owner@vger.kernel.org] On Behalf Of Chuck Lever
>>>>>> Sent: Wednesday, November 14, 2012 5:39 PM
>>>>>> To: linux-nfs@vger.kernel.org
>>>>>> Subject: [PATCH] nfs(5): Document the minorversion= mount option
>>>>>> 
>>>>>> Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
>>>>>> ---
>>>>>> 
>>>>>> Our pals on the Solaris team recently noticed that the minorversion= option
>>>>>> is not documented in nfs(5).  This is a first take, just to start the conversation.
>>>>>> I'm pretty sure I got the kernel version information wrong, for instance.
>>>>>> 
>>>>>> Any other comments?
>>>>> 
>>>>> You might want to note that it is deprecated in favour of the "vers=4.1" notation, and for that reason we might want to forgo documenting it altogether.
>>>> 
>>>> OK.  minorversion= is the only way to get NFSv4.1 on EL6-based distributions, isn't it?
>>> 
>>> You didn't seem to be writing a manpage for the RHEL-6 distros: "Before
>>> kernel 2.6.38, the minor version is always zero...". As far as I know,
>>> RHEL-6 is still based on 2.6.32...
> 2.6.32 is where we made the branch. So it accurate to say RHEL6 is based
> on 2.6.36, but in reality it absolutely not a straight 2.6.32 upstream 
> kernel due to all the backporting we do.  
> 
>> 
>> ...for some very loose definition of "based on".  One wonders how to document kernel versions in this instance.  One way to fix this is to have RH patch their copy of nfs(5) privately, while upstream nfs-utils can handle this in some other way.
> Yeah, We'll have to carry an private patch that updates the man page. 
> 
>> 
>> However, search for "Parallel NFS" on this page:
>> 
>>  https://access.redhat.com/knowledge/docs/en-US/Red_Hat_Enterprise_Linux/6/html-single/6.2_Release_Notes/index.html
>> 
>> This seems to me to count as public documentation of "minorversion=", and suggests that people are likely already using this formal API.  I would hesitate to remove it in this instance.
> If upstream wants to deprecate minorversion= than so be it... That will have
> little effect on a RHEL release since we can't change the API like that... 
> 
> steved.
--
To unsubscribe from this list: send the line "unsubscribe linux-nfs" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Steve Dickson Nov. 16, 2012, 2:12 p.m. UTC | #7 
On 16/11/12 09:05, Chuck Lever wrote:
> For the record I opened RH bugzilla 877052 yesterday to document this issue in RHEL 6.
Thank you!

steved.
--
To unsubscribe from this list: send the line "unsubscribe linux-nfs" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/utils/mount/nfs.man b/utils/mount/nfs.man
index c15de98..66198cc 100644
--- a/utils/mount/nfs.man
+++ b/utils/mount/nfs.man
@@ -777,6 +777,23 @@  so if this mount option is not specified, the NFS version 4 client
 uses the TCP protocol.
 Refer to the TRANSPORT METHODS section for more details.
 .TP 1.5i
+.BI minorversion= n
+Specifies the protocol minor version number.
+NFSv4 introduces "minor versioning," where NFS protocol enhancements can
+be introduced without bumping the NFS protocol version number.
+Before kernel 2.6.38, the minor version is always zero, and this
+option is not recognized.
+After this kernel, specifying "minorversion=1" enables a number of
+advanced features, such as NFSv4 sessions.
+.IP
+Recent kernels allow the minor version to be specified using the
+.B vers=
+option.
+For example, specifying
+.B vers=4.1
+is the same as specifying
+.BR vers=4,minorversion=1 .
+.TP 1.5i
 .BI port= n
 The numeric value of the server's NFS service port.
 If the server's NFS service is not available on the specified port,