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 1612214 - Man page scan results for opensm
Summary: Man page scan results for opensm
Keywords:
Status: CLOSED NOTABUG
Alias: None
Product: Fedora
Classification: Fedora
Component: opensm
Version: rawhide
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ---
Assignee: Honggang LI
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks: FedoraManpagescan
TreeView+ depends on / blocked
 
Reported: 2018-08-03 16:19 UTC by Maryna Nalbandian
Modified: 2018-08-06 02:33 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-08-06 02:33:14 UTC
Type: ---
Embargoed:

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

Description Maryna Nalbandian 2018-08-03 16:19:18 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 opensm
Comment 1 Maryna Nalbandian 2018-08-03 16:19:37 UTC 
Created attachment 1473097 [details]
Logs
Comment 2 Honggang LI 2018-08-06 02:33:14 UTC 
cat man_page.txt 
Current version of package:
opensm-3.3.20-8.fc28.x86_64

checking whether binary files have man pages:

[ OK ] binary /usr/sbin/opensm has man page /usr/share/man/man8/opensm.8.gz
[ Warn ] man page is in section 8. Only commands requiring admin privileges, or deamons should be in this section, the rest should be in section 1
[ OK ] binary /usr/sbin/osmtest has man page /usr/share/man/man8/osmtest.8.gz
[ Warn ] man page is in section 8. Only commands requiring admin privileges, or deamons should be in this section, the rest should be in section 1


=== Those two commands do need admin privileges to run. The warn message is expected.


checking whether config files have man pages:

[ Error ] config file /etc/logrotate.d/opensm has no man page! Check it's content for proper documentation

=== It is self document. If users need a doc for this, they should read manpage of "logrotate(8)".

[ Error ] config file /etc/rdma/opensm.conf has no man page! Check it's content for proper documentation

=== It is self document. There is comment for every thing in the file.

[ Error ] config file /etc/rdma/partitions.conf has no man page! Check it's content for proper documentation

=== Beside self document. There is documentation for partition in the opensm(8) file.


[ Error ] config file /etc/rwtab.d/opensm has no man page! Check it's content for proper documentation

=== Users should read "rwtab(5)", if they want to understand /etc/rwtab.d/opensm.


[ Error ] config file /etc/sysconfig/opensm has no man page! Check it's content for proper documentation

=== Self document file. There is in-line comment for every thing.


checking for unused man pages:

[ Warn ] these (2) man pages left unassigned:
/usr/share/man/man5/torus-2QoS.conf.5.gz
/usr/share/man/man8/torus-2QoS.8.gz

now checking individual man pages:

checking /usr/share/man/man5/torus-2QoS.conf.5.gz:
[ OK ] man page parsing with lexgrog succeeded
[ OK ] man page doesn't contain any repeated word

checking /usr/share/man/man8/opensm.8.gz:
[ OK ] man page parsing with lexgrog succeeded
[ OK ] man page doesn't contain any repeated word

checking /usr/share/man/man8/osmtest.8.gz:
[ OK ] man page parsing with lexgrog succeeded
[ OK ] man page doesn't contain any repeated word

checking /usr/share/man/man8/torus-2QoS.8.gz:
[ OK ] man page parsing with lexgrog succeeded
[ OK ] man page doesn't contain any repeated word

Summary: 10x OK, 3 warnings, 5 errors
Note You need to log in before you can comment on or make changes to this bug.