Bug 1612233

Summary: Man page scan results for pptp
Product: [Fedora] Fedora Reporter: Maryna Nalbandian <mnalband>
Component: pptpAssignee: Jaroslav Škarvada <jskarvad>
Status: CLOSED NOTABUG QA Contact: Fedora Extras Quality Assurance <extras-qa>
Severity: medium Docs Contact:
Priority: medium    
Version: 29CC: dkutalek, jskarvad, msekleta, paul
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: 2019-07-12 16:32:48 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:26:26 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 pptp
Comment 1 Maryna Nalbandian 2018-08-03 16:26:43 UTC 
Created attachment 1473116 [details]
Logs
Comment 2 Jan Kurik 2018-08-14 10:36:53 UTC 
This bug appears to have been reported against 'rawhide' during the Fedora 29 development cycle.
Changing version to '29'.
Comment 3 Jaroslav Škarvada 2019-07-12 16:32:48 UTC 
> Current version of package:
> pptp-1.10.0-3.fc28.x86_64
> 
> checking whether binary files have man pages:
> 
> [ [1m[32mOK(B[m ] binary /usr/sbin/pptp has man page /usr/share/man/man8/pptp.8.gz
> [ [1m[33mWarn(B[m ] man page is in section 8. Only commands requiring admin privileges, or deamons should be in this section, the rest should be in section 1
>
It's intended to be run by administrator.

> checking whether config files have man pages:
>
> [ [1m[31mError(B[m ] config file /etc/ppp/options.pptp has no man page! Check it's content for proper documentation
>
No manual page exists.