Bug 1231898

Summary: Doc: There are no mention about confflags (home, nodad, ...) in ip-address man-page
Product: Red Hat Enterprise Linux 7 Reporter: Jaroslav Aster <jaster>
Component: iprouteAssignee: Phil Sutter <psutter>
Status: CLOSED ERRATA QA Contact: Marek Marusic <mmarusic>
Severity: medium Docs Contact:
Priority: medium    
Version: 7.2CC: kzhang, mmarusic, rkhan
Target Milestone: rcKeywords: Documentation
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: iproute-3.10.0-57.el7 Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2016-11-03 23:33:06 UTC 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:
Bug Depends On:    
Bug Blocks: 1301628, 1313485    

Description Jaroslav Aster 2015-06-15 14:57:59 UTC
Description of problem:

There are no mention about confflags (home, nodad, ...) in ip-address man-page.

Version-Release number of selected component (if applicable):

iproute-3.10.0-39.el7

How reproducible:

100%

# ip addr help 2>&1 | grep CONFFLAG|grep ':='
CONFFLAG-LIST := [ CONFFLAG-LIST ] CONFFLAG
CONFFLAG  := [ home | nodad | mngtmpaddr | noprefixroute ]

# man ip-address | col -b |grep 'home'
# man ip-address | col -b |grep 'nodad'
# man ip-address | col -b |grep 'mngtmpaddr'
# man ip-address | col -b |grep 'noprefixroute'

Comment 2 Phil Sutter 2015-08-03 11:29:38 UTC
Seems like some of the requested information was dropped from ip-addess.8 when converting it to a template (ip-address.8.in) in commit e419f2d6f51be3ada145b1a8bd634a28bfac34d2.

Comment 3 Phil Sutter 2016-01-21 15:50:08 UTC
These issues have been addressed upstream meanwhile, at least the following commits should be backported:

commit 4e972d5ef41b28679a8125ed5289496284a9157f
Author: Pavel Šimerda <psimerda>
Date:   Wed Aug 12 22:04:08 2015 +0200

    ip-address: fix and extend documentation
    
     * Improve manual page synopsis and built-it help
     * Use full subcommand names (e.g. 'address' and 'maddress')
     * Specify when IPv4, IPv6 or both are affected
     * Add lifetimes, home and nodad
     * Remove any remaining excess spaces
    
    Commit 43d29f7 substantially improves generated ip-address.8 instead of
    ip-address.8.in and commit e419f2d removes the generated one losing the
    improvements entirely. This commit recovers the lost changes, adapts
    them to the current manual page and adds more man page and help
    improvements.
    
    Original commit by: Kenyon Ralph <kenyon>

commit 715296b85a0ecece7cdc60d42b026d66ac21a55e
Author: Phil Sutter <phil>
Date:   Tue Aug 18 18:11:12 2015 +0200

    ip-address.8.in: fix BNF syntax error
    
    The previous man page fixup introduced a syntax error due to missing
    opening bracket, which might crash some humanoid BNF parsers.
    
    Fixes: 4e972d5 ("ip-address: fix and extend documentation")
    Signed-off-by: Phil Sutter <phil>

commit 0b17394087a2c1b5564353bd21eb59f468130553
Author: Phil Sutter <phil>
Date:   Fri Sep 18 20:17:00 2015 +0200

    man: ip-address: align synopsis with help output
    
    When fixing the BNF syntax error, I overlooked that 'ip address help'
    prints a more correct synopsis. This patch aligns them.
    
    Fixes: 715296b ("ip-address.8.in: fix BNF syntax error")
    Signed-off-by: Phil Sutter <phil>

commit f7afa999520d3f93114c296e37e4ccea84d2c6de
Author: Phil Sutter <phil>
Date:   Fri Sep 18 20:17:03 2015 +0200

    man: ip-address: document mngtmpaddr and noprefixroute flags
    
    Signed-off-by: Phil Sutter <phil>

Comment 5 Phil Sutter 2016-01-21 20:43:57 UTC
Clearing pm_ack+ as that was a leftover from prior to moving target release.

Comment 8 Phil Sutter 2016-06-16 15:24:50 UTC
*** Bug 1264146 has been marked as a duplicate of this bug. ***

Comment 11 errata-xmlrpc 2016-11-03 23:33:06 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://rhn.redhat.com/errata/RHEA-2016-2162.html