Bug 1611200

Summary: Man page scan results for chrony
Product: [Fedora] Fedora Reporter: Maryna Nalbandian <mnalband>
Component: chronyAssignee: Miroslav Lichvar <mlichvar>
Status: CLOSED UPSTREAM QA Contact: Fedora Extras Quality Assurance <extras-qa>
Severity: medium Docs Contact:
Priority: medium    
Version: 29CC: dkutalek, mlichvar
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-09-12 08:48:44 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:03:07 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 chrony
Comment 1 Maryna Nalbandian 2018-08-02 08:03:22 UTC 
Created attachment 1472354 [details]
Logs
Comment 2 Jan Kurik 2018-08-14 10:51:00 UTC 
This bug appears to have been reported against 'rawhide' during the Fedora 29 development cycle.
Changing version to '29'.
Comment 3 Miroslav Lichvar 2018-09-12 08:48:44 UTC 
The warnings seem to be false positives.

Some of the errors are for files that are not actually marked as config files, or  they are files in well known locations like /etc/sysconfig, or /etc/logrotate, which typically don't have a man page.

I'll add a reference to chrony.conf(5) to the upstream example which is packaged as /etc/chrony.keys.