Bug 1611266

Summary: Man page scan results for expect
Product: [Fedora] Fedora Reporter: Maryna Nalbandian <mnalband>
Component: expectAssignee: Vitezslav Crhonek <vcrhonek>
Status: CLOSED NOTABUG QA Contact: Fedora Extras Quality Assurance <extras-qa>
Severity: medium Docs Contact:
Priority: medium    
Version: rawhideCC: dkutalek, vcrhonek
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 13:02:20 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-02 08:21:30 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 expect
Comment 1 Maryna Nalbandian 2018-08-02 08:21:45 UTC 
Created attachment 1472410 [details]
Logs
Comment 2 Jan Kurik 2018-08-14 10:48:45 UTC 
This bug appears to have been reported against 'rawhide' during the Fedora 29 development cycle.
Changing version to '29'.
Comment 3 Vitezslav Crhonek 2018-08-15 13:02:20 UTC 
Warnings:
1/1 - repeated words in /usr/share/man/man1/expect.1.gz - checked it manually, I see nothing suspicious there

Errors:
7/7 - binary has no man page - all these binaries are actually expect example scripts and their functionality is described within the script itself. In many cases, the man page would be longer that the script. (Note that there are also other example scripts which have man page included - but they're usually much more complex and useful in solving real problems than these seven without man page.)