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 1612196 - Man page scan results for netlabel_tools
Summary: Man page scan results for netlabel_tools
Keywords:
Status: CLOSED NOTABUG
Alias: None
Product: Fedora
Classification: Fedora
Component: netlabel_tools
Version: rawhide
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ---
Assignee: Paul Moore
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks: FedoraManpagescan
TreeView+ depends on / blocked
 
Reported: 2018-08-03 16:12 UTC by Maryna Nalbandian
Modified: 2018-08-03 19:58 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-08-03 19:58:04 UTC
Type: ---
Embargoed:

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

Description Maryna Nalbandian 2018-08-03 16:12:33 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 netlabel_tools
Comment 1 Maryna Nalbandian 2018-08-03 16:12:49 UTC 
Created attachment 1473078 [details]
Logs
Comment 2 Paul Moore 2018-08-03 19:58:04 UTC 
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.
Note You need to log in before you can comment on or make changes to this bug.