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 1611267 - Man page scan results for fabtests
Summary: Man page scan results for fabtests
Keywords:
Status: CLOSED UPSTREAM
Alias: None
Product: Fedora
Classification: Fedora
Component: fabtests
Version: 29
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-02 08:21 UTC by Maryna Nalbandian
Modified: 2018-08-21 05:02 UTC (History)
3 users (show)

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

Attachments (Terms of Use)
Logs (4.11 KB, text/plain)
2018-08-02 08:22 UTC, Maryna Nalbandian 		no flags Details
View All

Description Maryna Nalbandian 2018-08-02 08:21:48 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 fabtests
Comment 1 Maryna Nalbandian 2018-08-02 08:22:03 UTC 
Created attachment 1472411 [details]
Logs
Comment 2 Jan Kurik 2018-08-14 10:48:42 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-21 05:02:17 UTC 
> Current version of package:
> fabtests-1.6.0-1.fc29.x86_64
> 
> checking whether binary files have man pages:
> 
> [ Error ] binary /usr/bin/fi_av_test has no man page!
> [ Error ] binary /usr/bin/fi_av_xfer has no man page!
> [ Error ] binary /usr/bin/fi_cm_data has no man page!
> [ Error ] binary /usr/bin/fi_cmatose has no man page!
> [ Error ] binary /usr/bin/fi_cntr_test has no man page!
> [ Error ] binary /usr/bin/fi_cq_data has no man page!
> [ Error ] binary /usr/bin/fi_cq_test has no man page!
> [ Error ] binary /usr/bin/fi_dgram has no man page!
> [ Error ] binary /usr/bin/fi_dgram_pingpong has no man page!
> [ Error ] binary /usr/bin/fi_dgram_waitset has no man page!
> [ Error ] binary /usr/bin/fi_dom_test has no man page!
> [ Error ] binary /usr/bin/fi_eq_test has no man page!
> [ Error ] binary /usr/bin/fi_getinfo_test has no man page!
> [ Error ] binary /usr/bin/fi_inj_complete has no man page!
> [ Error ] binary /usr/bin/fi_mcast has no man page!
> [ Error ] binary /usr/bin/fi_mr_test has no man page!
> [ Error ] binary /usr/bin/fi_msg has no man page!
> [ Error ] binary /usr/bin/fi_msg_bw has no man page!
> [ Error ] binary /usr/bin/fi_msg_epoll has no man page!
> [ Error ] binary /usr/bin/fi_msg_pingpong has no man page!
> [ Error ] binary /usr/bin/fi_msg_rma has no man page!
> [ Error ] binary /usr/bin/fi_msg_sockets has no man page!
> [ Error ] binary /usr/bin/fi_msg_stream has no man page!
> [ Error ] binary /usr/bin/fi_multi_ep has no man page!
> [ Error ] binary /usr/bin/fi_multi_mr has no man page!
> [ Error ] binary /usr/bin/fi_poll has no man page!
> [ Error ] binary /usr/bin/fi_rc_pingpong has no man page!
> [ Error ] binary /usr/bin/fi_rdm has no man page!
> [ Error ] binary /usr/bin/fi_rdm_atomic has no man page!
> [ Error ] binary /usr/bin/fi_rdm_cntr_pingpong has no man page!
> [ Error ] binary /usr/bin/fi_rdm_deferred_wq has no man page!
> [ Error ] binary /usr/bin/fi_rdm_multi_domain has no man page!
> [ Error ] binary /usr/bin/fi_rdm_multi_recv has no man page!
> [ Error ] binary /usr/bin/fi_rdm_pingpong has no man page!
> [ Error ] binary /usr/bin/fi_rdm_rma has no man page!
> [ Error ] binary /usr/bin/fi_rdm_rma_simple has no man page!
> [ Error ] binary /usr/bin/fi_rdm_rma_trigger has no man page!
> [ Error ] binary /usr/bin/fi_rdm_shared_av has no man page!
> [ Error ] binary /usr/bin/fi_rdm_tagged_bw has no man page!
> [ Error ] binary /usr/bin/fi_rdm_tagged_peek has no man page!
> [ Error ] binary /usr/bin/fi_rdm_tagged_pingpong has no man page!
> [ Error ] binary /usr/bin/fi_recv_cancel has no man page!
> [ Error ] binary /usr/bin/fi_resmgmt_test has no man page!
> [ Error ] binary /usr/bin/fi_resource_freeing has no man page!
> [ Error ] binary /usr/bin/fi_rma_bw has no man page!
> [ Error ] binary /usr/bin/fi_scalable_ep has no man page!
> [ Error ] binary /usr/bin/fi_shared_ctx has no man page!
> [ Error ] binary /usr/bin/fi_ubertest has no man page!
> [ Error ] binary /usr/bin/fi_unexpected_msg has no man page!

User can get usage of each tool by passing "-h" to all tool. For example,

$ fi_strerror  -h
Usage: fi_strerror FI_ERROR_CODE

Displays the error string for the given numeric FI_ERROR_CODE.
FI_ERROR_CODE may be a hexadecimal, octal, or decimal constant.
For convenience, the absolute value of FI_ERROR_CODE will be used.


> [ Error ] binary /usr/bin/rft_yaml_to_junit_xml has no man page!

inline doc is available in this ruby script.

# Transform YAML-formatted runfabtests.sh output on STDIN into jUnit-formatted
# XML on STDOUT.

> [ Error ] binary /usr/bin/runfabtests.sh has no man page!

/usr/bin/runtest --help 
It will print usage message too.

> 
> checking whether config files have man pages:
> 
> 
> checking for unused man pages:
> 
> [ Warn ] these (1) man pages left unassigned:
> /usr/share/man/man7/fabtests.7.gz
> 
> now checking individual man pages:
> 
> checking /usr/share/man/man7/fabtests.7.gz:
> [ OK ] man page parsing with lexgrog succeeded
> [ OK ] man page doesn't contain any repeated word
> 
> Summary: 2x OK, 1 warnings, 51 errors

Report this issue to upstream. Once upstream fixed this issue, the doc will available in Fedora rpm building too. 

BTW users can get usage for all tests run via /usr/bin/runtest.

Close it as UPSTREAM.
Note You need to log in before you can comment on or make changes to this bug.