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
| Summary: | Man page scan results for wpa_supplicant | ||||||
|---|---|---|---|---|---|---|---|
| Product: | [Fedora] Fedora | Reporter: | Maryna Nalbandian <mnalband> | ||||
| Component: | wpa_supplicant | Assignee: | Davide Caratti <dcaratti> | ||||
| Status: | CLOSED NOTABUG | QA Contact: | Fedora Extras Quality Assurance <extras-qa> | ||||
| Severity: | medium | Docs Contact: | |||||
| Priority: | medium | ||||||
| Version: | 29 | CC: | bgalvani, blueowl, dcaratti, dcbw, dkutalek, john.j5live, lkundrak | ||||
| 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-01-14 11:21:28 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: |
|
||||||
Created attachment 1473206 [details]
Logs
This bug appears to have been reported against 'rawhide' during the Fedora 29 development cycle. Changing version to '29'. 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. |
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