Bug 1612196
| Summary: | Man page scan results for netlabel_tools | ||||||
|---|---|---|---|---|---|---|---|
| Product: | [Fedora] Fedora | Reporter: | Maryna Nalbandian <mnalband> | ||||
| Component: | netlabel_tools | Assignee: | Paul Moore <pmoore> | ||||
| Status: | CLOSED NOTABUG | QA Contact: | Fedora Extras Quality Assurance <extras-qa> | ||||
| Severity: | medium | Docs Contact: | |||||
| Priority: | medium | ||||||
| Version: | rawhide | CC: | dkutalek, pmoore, pvrabec | ||||
| 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: | 2018-08-03 19:58:04 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 1473078 [details]
Logs
A quick analysis of the issues from the attachment in comment #1: > Current version of package: > netlabel_tools-0.30.0-4.fc29.x86_64 > > checking whether binary files have man pages: > > [...] binary /usr/sbin/netlabel-config has man page > /usr/share/man/man8/netlabel-config.8.gz > [...] 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 The netlabel-config script is a system management tool, primarily used by systemd, and required admin privileges to run. > [...] binary /usr/sbin/netlabelctl has man page > /usr/share/man/man8/netlabelctl.8.gz > [...] 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 The netlabelctl program is the primary NetLabel configuration utility and requires admin privileges to run. > checking whether config files have man pages: > > [...] config file /etc/netlabel.rules has no man page! Check it's content for > proper documentation /etc/netlabel.rules is extensively documented with comments and examples. > checking for unused man pages: > > [...] no man pages left > > now checking individual man pages: > > checking /usr/share/man/man8/netlabel-config.8.gz: > [...] man page parsing with lexgrog succeeded > [...] man page doesn't contain any repeated word > > checking /usr/share/man/man8/netlabelctl.8.gz: > [...] man page parsing with lexgrog succeeded > [...] man page doesn't contain any repeated word > > Summary: 7x OK, 2 warnings, 1 errors I'm not seeing any problems in this report, closing this BZ as NOTABUG. |
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 netlabel_tools