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 1612243

Summary: Man page scan results for qt5-qttools
Product: [Fedora] Fedora Reporter: Maryna Nalbandian <mnalband>
Component: qt5-qttoolsAssignee: Than Ngo <than>
Status: CLOSED WONTFIX QA Contact: Fedora Extras Quality Assurance <extras-qa>
Severity: medium Docs Contact:
Priority: medium    
Version: rawhideCC: dkutalek, jgrulich, jreznik, me, rdieter, than
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-07 14:00:33 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:
Description Flags
Logs none

Description Maryna Nalbandian 2018-08-03 16:30: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 qt5-qttools

Comment 1 Maryna Nalbandian 2018-08-03 16:30:36 UTC
Created attachment 1473127 [details]
Logs

Comment 2 Rex Dieter 2018-08-07 14:00:33 UTC
Current version of package:
qt5-qttools-5.11.0-1.fc29.x86_64

checking whether binary files have man pages:

[ [1m[31mError(B[m ] binary /usr/bin/qdbus-qt5 has no man page!
[ [1m[31mError(B[m ] binary /usr/bin/qtpaths has no man page!

checking whether config files have man pages:


checking for unused man pages:

[ [1m[32mOK(B[m ] no man pages left

now checking individual man pages:

Summary: 1x OK, 0 warnings, 2 errors


Mostly non-user facing utilities here, may consider employing help2man in the future to improve this.