Note: This is a public test instance of Red Hat Bugzilla. The data contained within is a snapshot of the live data so any changes you make will not be reflected in the production Bugzilla. Email is disabled so feel free to test any aspect of the site that you want. File any problems you find or give feedback at bugzilla.redhat.com.
Bug 1612159 - Man page scan results for OpenIPMI
Summary: Man page scan results for OpenIPMI
Keywords:
Status: CLOSED RAWHIDE
Alias: None
Product: Fedora
Classification: Fedora
Component: OpenIPMI
Version: rawhide
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ---
Assignee: Josef Ridky
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks: FedoraManpagescan
TreeView+ depends on / blocked
 
Reported: 2018-08-03 15:58 UTC by Maryna Nalbandian
Modified: 2018-09-05 10:59 UTC (History)
5 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-08-09 11:49:03 UTC
Type: ---
Embargoed:

Attachments (Terms of Use)
Logs (3.28 KB, text/plain)
2018-08-03 15:59 UTC, Maryna Nalbandian 		no flags Details
View All

Description Maryna Nalbandian 2018-08-03 15:58:47 UTC 
In order to improve usability of packages in Fedora, project Man Page Scan was created and its task is to provide consistency of man pages (and documentation in general). The results are now available for package maintainers to fix documentation issues.

If you need to re-run the check yourself, here is the simple process of man page check:

1. Download man-page-day from:

    https://pagure.io/ManualPageScan/blob/master/f/man-page-day.sh

2. Run the script:
    $ ./man-page-day.sh OpenIPMI
Comment 1 Maryna Nalbandian 2018-08-03 15:59:05 UTC 
Created attachment 1473044 [details]
Logs
Comment 2 Josef Ridky 2018-08-09 11:49:03 UTC 
Missing man page isn't available in upstream.
Comment 3 "FeRD" (Frank Dana) 2018-08-24 20:58:28 UTC 
I'm sort of surprised that the man-page-day scanner didn't catch it, but this:

checking /usr/share/man/man1/ipmicmd.1.gz:
this man page is link to /usr/share/man/man1/ipmicmd.1.gz, skipping

Is actually a problem, and because of it the first time you try to read that man page, you get only:

$ man ipmicmd 
man: /usr/share/man/man1/ipmicmd.1 is self referencing
No manual entry for ipmicmd

(Subsequent attempts won't even produce the "is self referencing" message.)

I _suspect_ /usr/share/man/man1/ipmicmd.1 is supposed to link to openipmicmd.1, the same way ipmish.1 links to openipmish.1:

#
# This works fine
#
$ zcat /usr/share/man/man1/ipmish.1.gz
.so man1/openipmish.1

#
# This breaks
#
$ zcat /usr/share/man/man1/ipmicmd.1.gz
.so man1/ipmicmd.1
Comment 4 "FeRD" (Frank Dana) 2018-08-24 21:33:22 UTC 
Filed the above as bug 1622247.
Comment 5 Josef Ridky 2018-09-05 10:59:06 UTC 
Fixed in Fedora.
Note You need to log in before you can comment on or make changes to this bug.