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 1612188

Summary: Man page scan results for mrtg
Product: [Fedora] Fedora Reporter: Maryna Nalbandian <mnalband>
Component: mrtgAssignee: Vitezslav Crhonek <vcrhonek>
Status: CLOSED RAWHIDE QA Contact: Fedora Extras Quality Assurance <extras-qa>
Severity: medium Docs Contact:
Priority: medium    
Version: rawhideCC: anon.amish, dkutalek, vcrhonek
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: mrtg-2.17.7-2.fc30 Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2018-10-18 11:55: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-03 16:09:41 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 mrtg

Comment 1 Maryna Nalbandian 2018-08-03 16:09:58 UTC
Created attachment 1473070 [details]
Logs

Comment 2 Jan Kurik 2018-08-14 10:39:04 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-10-18 10:54:50 UTC
Errors:
[ Error ] binary /usr/bin/mrtg-traffic-sum has no man page!
 - the man page is incorporated inside the script and there's an option '--man' which shows the man page (fix needed, currently the option is NOT recognized)
[ Error ] binary /usr/bin/rateup has no man page!
- rateup is not intended to be run by users from cmd line, it's called by main mrtg script with relevant options
[ Error ] config file /etc/httpd/conf.d/mrtg.conf has no man page! Check it's content for proper documentation
- this is standard httpd configuration file, there's no reason for special man page within mrtg package (some info about httpd configuration is for example in /usr/share/man/man1/mrtg-webserver.1.gz)
[ Error ] config file /etc/mrtg/mrtg.cfg has no man page! Check it's content for proper documentation
- mrtg.cfg file is usually generated by /usr/bin/cfgmaker, usage and content is described in /usr/share/man/man1/cfgmaker.1.gz, additional info can be found in /usr/share/man/man1/mrtg-reference.1.gz and other man pages

Warnings:
[ Warn ] these (14) man pages left unassigned:
/usr/share/man/man1/mrtg-contrib.1.gz                                                                                                                                                                             
/usr/share/man/man1/mrtg-faq.1.gz                                                                                                                                                                                 
/usr/share/man/man1/mrtg-forum.1.gz                                                                                                                                                                               
/usr/share/man/man1/mrtg-ipv6.1.gz                                                                                                                                                                                
/usr/share/man/man1/mrtg-logfile.1.gz                                                                                                                                                                             
/usr/share/man/man1/mrtg-mibhelp.1.gz                                                                                                                                                                             
/usr/share/man/man1/mrtg-nt-guide.1.gz                                                                                                                                                                            
/usr/share/man/man1/mrtg-nw-guide.1.gz                                                                                                                                                                            
/usr/share/man/man1/mrtg-reference.1.gz                                                                                                                                                                           
/usr/share/man/man1/mrtg-rrd.1.gz                                                                                                                                                                                 
/usr/share/man/man1/mrtg-squid.1.gz                                                                                                                                                                               
/usr/share/man/man1/mrtg-unix-guide.1.gz                                                                                                                                                                          
/usr/share/man/man1/mrtg-webserver.1.gz                                                                                                                                                                           
/usr/share/man/man1/mrtglib.1.gz
- these man pages contain various useful information about mrtg not related to specific binary, it's ok
[ Warn ] found repeated words in man page: are the
[ Warn ] found repeated words in man page: IPv6
[ Warn ] found repeated words in man page: so
[ Warn ] found repeated words in man page: WorkDir HtmlDir ImageDir LogDir the Title BodyTag the
[ Warn ] found repeated words in man page: the
- all these warnings are harmless, nothing to fix here

Conclusion - I'll do minor fix in /usr/bin/mrtg-traffic-sum to enable '--man' option, the rest looks fine.