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 1612232 - Man page scan results for ppp
Summary: Man page scan results for ppp
Keywords:
Status: CLOSED NOTABUG
Alias: None
Product: Fedora
Classification: Fedora
Component: ppp
Version: 29
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ---
Assignee: Jaroslav Škarvada
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks: FedoraManpagescan
TreeView+ depends on / blocked
 
Reported: 2018-08-03 16:26 UTC by Maryna Nalbandian
Modified: 2019-07-12 16:22 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-07-12 16:22:44 UTC
Type: ---
Embargoed:

Attachments (Terms of Use)
Logs (5.02 KB, text/plain)
2018-08-03 16:26 UTC, Maryna Nalbandian 		no flags Details
View All

Description Maryna Nalbandian 2018-08-03 16:26:03 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 ppp
Comment 1 Maryna Nalbandian 2018-08-03 16:26:21 UTC 
Created attachment 1473115 [details]
Logs
Comment 2 Jan Kurik 2018-08-14 10:36:56 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:22:44 UTC 
> Current version of package:
> ppp-2.4.7-22.fc29.x86_64
> 
> checking whether binary files have man pages:
> 
> [ [1m[32mOK(B[m ] binary /usr/sbin/chat has man page /usr/share/man/man8/chat.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
> [ [1m[32mOK(B[m ] binary /usr/sbin/ppp-watch has man page /usr/share/man/man8/ppp-watch.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
> [ [1m[32mOK(B[m ] binary /usr/sbin/pppd has man page /usr/share/man/man8/pppd.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
> [ [1m[32mOK(B[m ] binary /usr/sbin/pppdump has man page /usr/share/man/man8/pppdump.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
> [ [1m[32mOK(B[m ] binary /usr/sbin/pppoe-discovery has man page /usr/share/man/man8/pppoe-discovery.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
> [ [1m[32mOK(B[m ] binary /usr/sbin/pppstats has man page /usr/share/man/man8/pppstats.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
>
All are intedned to be run by admin only.

> checking whether config files have man pages:
>
> [ [1m[31mError(B[m ] config file /etc/logrotate.d/ppp has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/pam.d/ppp has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/ppp/chap-secrets has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/ppp/eaptls-client has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/ppp/eaptls-server has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/ppp/ip-down has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/ppp/ip-down.ipv6to4 has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/ppp/ip-up has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/ppp/ip-up.ipv6to4 has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/ppp/ipv6-down has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/ppp/ipv6-up has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/ppp/options has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/ppp/pap-secrets has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/sysconfig/network-scripts/ifdown-ppp has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/sysconfig/network-scripts/ifup-ppp has no man page! Check it's content for proper documentation
> 
No manual page exists.

> checking /usr/share/man/man8/chat.8.gz:
> [ [1m[32mOK(B[m ] man page parsing with lexgrog succeeded
> [ [1m[33mWarn(B[m ] found repeated words in man page: l, 
>
False positive

> checking /usr/share/man/man8/pppd.8.gz:
> [ [1m[32mOK(B[m ] man page parsing with lexgrog succeeded
> [ [1m[33mWarn(B[m ] found repeated words in man page: directory name 0x73, 
>
False positives
Note You need to log in before you can comment on or make changes to this bug.