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 1612304
| Summary: | Man page scan results for tuned | ||||||
|---|---|---|---|---|---|---|---|
| Product: | [Fedora] Fedora | Reporter: | Maryna Nalbandian <mnalband> | ||||
| Component: | tuned | Assignee: | Jaroslav Škarvada <jskarvad> | ||||
| Status: | CLOSED NOTABUG | QA Contact: | Fedora Extras Quality Assurance <extras-qa> | ||||
| Severity: | medium | Docs Contact: | |||||
| Priority: | medium | ||||||
| Version: | 29 | CC: | dkutalek, jskarvad, olysonek, pknirsch | ||||
| 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-03-29 16:27:47 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 1473184 [details]
Logs
This bug appears to have been reported against 'rawhide' during the Fedora 29 development cycle. Changing version to '29'. (In reply to Maryna Nalbandian from comment #1) > Created attachment 1473184 [details] > Logs Thanks for the report. Could you update the tool, to provide the logs without the escape sequences (for the next scans)? It would be better for devels (at least for me :). It looks like all are false positives. > [ OK ] binary /usr/sbin/tuned has man page /usr/share/man/man8/tuned.8.gz > [ Warn ] 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 > [ OK ] binary /usr/sbin/tuned-adm has man page /usr/share/man/man8/tuned-adm.8.gz > [ Warn ] 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 Both OK, both commands requires admin privileges. > [ Error ] config file /etc/dbus-1/system.d/com.redhat.tuned.conf has no man page! Check it's content for proper documentation > [ Error ] config file /etc/modprobe.d/kvm.rt.tuned.conf has no man page! Check it's content for proper documentation > [ Error ] config file /etc/tuned/active_profile has no man page! Check it's content for proper documentation > [ Error ] config file /etc/tuned/bootcmdline has no man page! Check it's content for proper documentation > [ Error ] config file /etc/tuned/profile_mode has no man page! Check it's content for proper documentation None of them should be configured by user, so there is no need for the manual page. > [ Warn ] these (1) man pages left unassigned: > /usr/share/man/man7/tuned-profiles.7.gz This is general manual page about 'tuned-profiles' no command of this name exists, so probably OK. Also the tool didn't spot that there is no manual page for the tuned-gui (this has been spotted by rpmdiff). But this has been already fixed upstream and it will get to the Fedora with next Tuned rebase (probably tuned-2.12). It's very minor problem so we will probably not fix it downstream before the upstream release. |
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 tuned