Bug 1834385

Summary: Man page syntax issue detected by rpminspect
Product: Red Hat Enterprise Linux 7 Reporter: Florence Blanc-Renaud <frenaud>
Component: ipaAssignee: Florence Blanc-Renaud <frenaud>
Status: CLOSED ERRATA QA Contact: ipa-qe <ipa-qe>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 7.9CC: ksiddiqu, myusuf, rcritten, tscherf
Target Milestone: rc   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: ipa-4.6.8-3.el7 Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2020-09-29 19:59:37 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Florence Blanc-Renaud 2020-05-11 15:52:12 UTC
Cloned from upstream: https://pagure.io/freeipa/issue/8273

rpminspect detected the following syntax issues in the man pages:
```
        {
            "details": "Error parsing ipa-cacert-manage.1.gz:82:1: ERROR: skipping end of block that is not open: RE\nError parsing ipa-cacert-manage.1.gz:115:1: ERROR: skipping end of block that is not open: RE\nErrors found validating /usr/share/man/man1/ipa-cacert-manage.1.gz\n",
            "message": "Man page checker reported problems with /usr/share/man/man1/ipa-cacert-manage.1.gz on x86_64",
            "remedy": "Correct the errors in the man page as reported by the libmandoc parser.",
            "result": "VERIFY",
            "waiver authorization": "Anyone"
        },
        {
            "details": "Error parsing default.conf.5.gz:50:1: ERROR: skipping unknown macro: .DS L\nError parsing default.conf.5.gz:57:1: ERROR: skipping unknown macro: .DE\nErrors found validating /usr/share/man/man5/default.conf.5.gz\n",
            "message": "Man page checker reported problems with /usr/share/man/man5/default.conf.5.gz on noarch",
            "remedy": "Correct the errors in the man page as reported by the libmandoc parser.",
            "result": "VERIFY",
            "waiver authorization": "Anyone"
        }
```

To reproduce, install mandoc package and run:
`mandoc -T lint -W error client/man/default.conf.5`

Comment 2 Florence Blanc-Renaud 2020-05-11 15:54:13 UTC
Upstream ticket:
https://pagure.io/freeipa/issue/8273

Comment 3 Florence Blanc-Renaud 2020-05-11 15:56:12 UTC
Fixed upstream:
master:
    7ac60a8 Man pages: fix syntax issues

ipa-4-8:
    98045dc Man pages: fix syntax issues

ipa-4-6:
    b8d9d3c Man pages: fix syntax issues

Comment 6 Mohammad Rizwan 2020-05-14 11:31:09 UTC
stpes:
[root@master ~]# git clone https://github.com/freeipa/freeipa.git
[root@master ~]# cd freeipa

[root@master freeipa]# mandoc -T lint -W error client/man/default.conf.5
[root@master freeipa]# echo $?
0

[root@master freeipa]# mandoc -T lint -W error install/tools/man/ipa-cacert-manage.1
[root@master freeipa]# echo $?
0

No error observed. Hence marking the bug as verified.

Comment 8 errata-xmlrpc 2020-09-29 19:59:37 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 (Moderate: ipa security, bug fix, and enhancement update), 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://access.redhat.com/errata/RHSA-2020:3936