Bug 1611370
| Summary: | Man page scan results for rdma-core | ||||||
|---|---|---|---|---|---|---|---|
| Product: | [Fedora] Fedora | Reporter: | Maryna Nalbandian <mnalband> | ||||
| Component: | rdma-core | Assignee: | Jarod Wilson <jarodwilson> | ||||
| Status: | CLOSED NOTABUG | QA Contact: | Fedora Extras Quality Assurance <extras-qa> | ||||
| Severity: | medium | Docs Contact: | |||||
| Priority: | medium | ||||||
| Version: | 29 | CC: | dkutalek, dledford, honli, rdma-dev-team | ||||
| Target Milestone: | --- | ||||||
| Target Release: | --- | ||||||
| Hardware: | Unspecified | ||||||
| OS: | Unspecified | ||||||
| Whiteboard: | |||||||
| Fixed In Version: | Doc Type: | If docs needed, set a value | |||||
| Doc Text: | Story Points: | --- | |||||
| Clone Of: | Environment: | ||||||
| Last Closed: | 2018-08-15 00:40:13 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: | |||||||
| Bug Depends On: | |||||||
| Bug Blocks: | 1600386 | ||||||
| Attachments: |
|
||||||
Created attachment 1472504 [details]
Logs
This bug appears to have been reported against 'rawhide' during the Fedora 29 development cycle. Changing version to '29'. 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 *** Bug 1611406 has been marked as a duplicate of this bug. *** *** Bug 1611453 has been marked as a duplicate of this bug. *** |
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