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 1612323 - Man page scan results for wpa_supplicant
Summary: Man page scan results for wpa_supplicant
Keywords:
Status: CLOSED NOTABUG
Alias: None
Product: Fedora
Classification: Fedora
Component: wpa_supplicant
Version: 29
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ---
Assignee: Davide Caratti
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks: FedoraManpagescan
TreeView+ depends on / blocked
 
Reported: 2018-08-03 16:58 UTC by Maryna Nalbandian
Modified: 2019-01-14 11:21 UTC (History)
7 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-01-14 11:21:28 UTC
Type: ---
Embargoed:

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

Description Maryna Nalbandian 2018-08-03 16:58:19 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 wpa_supplicant
Comment 1 Maryna Nalbandian 2018-08-03 16:58:38 UTC 
Created attachment 1473206 [details]
Logs
Comment 2 Jan Kurik 2018-08-14 11:11:41 UTC 
This bug appears to have been reported against 'rawhide' during the Fedora 29 development cycle.
Changing version to '29'.
Comment 3 Davide Caratti 2019-01-14 11:21:28 UTC 
a)

[ Warning ] 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
 binary /usr/sbin/wpa_passphrase has man page /usr/share/man/man8/wpa_passphrase.8.gz

this is theoretically true for wpa_passphrase, but that command is in /usr/sbin since the earliest versions of wpa_supplicant. Moving it elsewhere for the upstream project has a high probability of breaking scripts where its location is hardcoded, so I'm for leaving it there and mark this as false positive.


b)

[ Error ] config file /etc/logrotate.d/wpa_supplicant has no man page! Check it's content for proper documentation
[ Error ] config file /etc/sysconfig/wpa_supplicant has no man page! Check it's content for proper documentation

logrotate and systemd configuration files don't need a documentation. I'm for marking the above two cases as false positive.

[ Error ] config file /etc/wpa_supplicant/wpa_supplicant.conf has no man page! Check it's content for proper documentation

as per the output of 

$ man 5 wpa_supplicant.conf

I'm for marking the above one as false positive.
Note You need to log in before you can comment on or make changes to this bug.