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 1611370 - Man page scan results for rdma-core
Summary: Man page scan results for rdma-core
Keywords:
Status: CLOSED NOTABUG
Alias: None
Product: Fedora
Classification: Fedora
Component: rdma-core
Version: 29
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ---
Assignee: Jarod Wilson
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
: 1611406 1611453 (view as bug list)
Depends On:
Blocks: FedoraManpagescan
TreeView+ depends on / blocked
 
Reported: 2018-08-02 08:50 UTC by Maryna Nalbandian
Modified: 2018-08-15 00:49 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-08-15 00:40:13 UTC
Type: ---
Embargoed:

Attachments (Terms of Use)
Logs (deleted)
2018-08-02 08:50 UTC, Maryna Nalbandian 		no flags Details
View All

Description Maryna Nalbandian 2018-08-02 08:50:28 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 rdma-core
Comment 1 Maryna Nalbandian 2018-08-02 08:50:44 UTC 
Created attachment 1472504 [details]
Logs
Comment 2 Jan Kurik 2018-08-14 10:45:07 UTC 
This bug appears to have been reported against 'rawhide' during the Fedora 29 development cycle.
Changing version to '29'.
Comment 3 Honggang LI 2018-08-15 00:40:13 UTC 
cat rdma-core-man_page.txt 
Current version of package:
rdma-core-16.2-3.fc28.x86_64

checking whether binary files have man pages:

[ OK ] binary /usr/bin/rxe_cfg has man page /usr/share/man/man8/rxe_cfg.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/rdma-ndd has man page /usr/share/man/man8/rdma-ndd.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


==== rxe_cfg and rdma-ndd needs admin privileges, so this warning message is expected.


checking whether config files have man pages:

[ Error ] config file /etc/modprobe.d/mlx4.conf has no man page! Check it's content for proper documentation
[ Error ] config file /etc/modprobe.d/truescale.conf has no man page! Check it's content for proper documentation
[ Error ] config file /etc/rdma/mlx4.conf has no man page! Check it's content for proper documentation
[ Error ] config file /etc/rdma/modules/infiniband.conf has no man page! Check it's content for proper documentation
[ Error ] config file /etc/rdma/modules/iwarp.conf has no man page! Check it's content for proper documentation
[ Error ] config file /etc/rdma/modules/opa.conf has no man page! Check it's content for proper documentation
[ Error ] config file /etc/rdma/modules/rdma.conf has no man page! Check it's content for proper documentation
[ Error ] config file /etc/rdma/modules/roce.conf has no man page! Check it's content for proper documentation
[ Error ] config file /etc/rdma/rdma.conf has no man page! Check it's content for proper documentation
[ Error ] config file /etc/rdma/sriov-vfs has no man page! Check it's content for proper documentation
[ Error ] config file /etc/udev/rules.d/70-persistent-ipoib.rules has no man page! Check it's content for proper documentation


==== All of those configuration files have inline documentation. Example is available for most of them. So, they are OK too.


checking for unused man pages:

[ Warn ] these (1) man pages left unassigned:
/usr/share/man/man7/rxe.7.gz

===== This one is general manpage for rxe. It is ok too.

now checking individual man pages:

checking /usr/share/man/man7/rxe.7.gz:
[ OK ] man page parsing with lexgrog succeeded
[ OK ] man page doesn't contain any repeated word

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

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

Summary: 8x OK, 3 warnings, 11 errors
Comment 4 Honggang LI 2018-08-15 00:48:52 UTC 
*** Bug 1611406 has been marked as a duplicate of this bug. ***
Comment 5 Honggang LI 2018-08-15 00:49:37 UTC 
*** Bug 1611453 has been marked as a duplicate of this bug. ***
Note You need to log in before you can comment on or make changes to this bug.