Bug 2203092

Summary: Fix typo in man page nfs.conf.man
Product: Red Hat Enterprise Linux 9 Reporter: Lukas Herbolt <lherbolt>
Component: nfs-utilsAssignee: Steve Dickson <steved>
Status: VERIFIED --- QA Contact: Yongcheng Yang <yoyang>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 9.1CC: steved, xzhou
Target Milestone: rcKeywords: EasyFix, Patch, Triaged
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: nfs-utils-2.5.4-19.el9 Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Lukas Herbolt 2023-05-11 08:46:11 UTC
Description of problem:
SMall typo in man page describing the values in nfs.conf

Version-Release number of selected component (if applicable):
RHEL 9.1 but also fedora 36 

How reproducible:
Everytime 

Steps to Reproduce:
1) open man nfs.conf 
2) check the options for mountd and exportd

Actual results:
Wrong value: cache-use-upaddr

Expected results:
Correct value: cache-use-ipaddr

Additional info:

[lherbolt@trufa nfs-utils-2.5.4]Φ diff systemd/nfs.conf.man systemd/nfs.conf.man.fixed
--- systemd/nfs.conf.man	2023-05-11 10:41:53.639699341 +0200
+++ systemd/nfs.conf.man.fixed	2023-05-11 10:42:23.637772191 +0200
@@ -132,7 +132,7 @@
 .B exportd
 Recognized values:
 .BR threads ,
-.BR cache-use-upaddr ,
+.BR cache-use-ipaddr ,
 .BR ttl ,
 .BR state-directory-path
 
@@ -197,7 +197,7 @@
 .BR port ,
 .BR threads ,
 .BR reverse-lookup ,
-.BR cache-use-upaddr ,
+.BR cache-use-ipaddr ,
 .BR ttl ,
 .BR state-directory-path ,
 .BR ha-callout .

Comment 1 Lukas Herbolt 2023-05-11 12:59:46 UTC
One more missing thing is manage-gids

[lherbolt@trufa nfs-utils-2.5.4]Φ diff ./systemd/nfs.conf.man ./systemd/nfs.conf.man.fixed
--- ./systemd/nfs.conf.man	2023-05-11 10:41:53.639699341 +0200
+++ ./systemd/nfs.conf.man.fixed	2023-05-11 14:38:18.108999555 +0200
@@ -131,8 +131,9 @@
 .TP
 .B exportd
 Recognized values:
+.BR manage-gids,
 .BR threads ,
-.BR cache-use-upaddr ,
+.BR cache-use-ipaddr ,
 .BR ttl ,
 .BR state-directory-path
 
@@ -197,7 +198,7 @@
 .BR port ,
 .BR threads ,
 .BR reverse-lookup ,
-.BR cache-use-upaddr ,
+.BR cache-use-ipaddr ,
 .BR ttl ,
 .BR state-directory-path ,
 .BR ha-callout .

Comment 2 Yongcheng Yang 2023-05-11 13:49:41 UTC
(In reply to Lukas Herbolt from comment #0)
> Description of problem:
> SMall typo in man page describing the values in nfs.conf
> 
> Version-Release number of selected component (if applicable):
> RHEL 9.1 but also fedora 36 

Thanks for the report!

The typo also exists in the upstream version and it needs to get fixed there firstly.

Would you like to send the patch to linux-nfs.org and cc steved if possible?

Btw please use this upstream repo to generate the patch:
$ git clone git://git.linux-nfs.org/~steved/nfs-utils.git

Comment 3 Lukas Herbolt 2023-05-11 14:02:17 UTC
(In reply to Yongcheng Yang from comment #2)
> (In reply to Lukas Herbolt from comment #0)
> > Description of problem:
> > SMall typo in man page describing the values in nfs.conf
> > 
> > Version-Release number of selected component (if applicable):
> > RHEL 9.1 but also fedora 36 
> 
> Thanks for the report!
> 
> The typo also exists in the upstream version and it needs to get fixed there
> firstly.
> 
> Would you like to send the patch to linux-nfs.org and cc
> steved if possible?
> 
> Btw please use this upstream repo to generate the patch:
> $ git clone git://git.linux-nfs.org/~steved/nfs-utils.git

Sure will send patch to upstream

Comment 6 Yongcheng Yang 2023-06-07 02:26:27 UTC
Verified in nfs-utils-2.5.4-19.el9

[root@hp-dl385g7-01-vm-03 ~]# rpm -q nfs-utils
nfs-utils-2.5.4-18.el9.x86_64
[root@hp-dl385g7-01-vm-03 ~]# man nfs.conf | grep cache-use-*
              Recognized values: threads, cache-use-upaddr, ttl, state-directory-path
       mountd Recognized values: manage-gids, descriptors, port, threads, reverse-lookup, cache-use-upaddr,  ttl,  state-di‐
[root@hp-dl385g7-01-vm-03 ~]# 
[root@hp-dl385g7-01-vm-03 ~]# 
[root@hp-dl385g7-01-vm-03 ~]# rpm -Uvh nfs-utils-2.5.4-19.el9.x86_64.rpm
Verifying...                          ################################# [100%]
Preparing...                          ################################# [100%]
Updating / installing...
   1:nfs-utils-1:2.5.4-19.el9         ################################# [ 50%]
Cleaning up / removing...
   2:nfs-utils-1:2.5.4-18.el9         ################################# [100%]
[root@hp-dl385g7-01-vm-03 ~]# man nfs.conf | grep cache-use-*
              Recognized values: manage-gids, threads, cache-use-ipaddr, ttl, state-directory-path
       mountd Recognized values: manage-gids, descriptors, port, threads, reverse-lookup, cache-use-ipaddr,  ttl,  state-di‐
[root@hp-dl385g7-01-vm-03 ~]# rpm -q nfs-utils
nfs-utils-2.5.4-19.el9.x86_64
[root@hp-dl385g7-01-vm-03 ~]#