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 1611146

Summary: Man page scan results for acpid
Product: [Fedora] Fedora Reporter: Maryna Nalbandian <mnalband>
Component: acpidAssignee: Jaroslav Škarvada <jskarvad>
Status: CLOSED NOTABUG QA Contact: Fedora Extras Quality Assurance <extras-qa>
Severity: medium Docs Contact:
Priority: medium    
Version: 29CC: dkutalek, jskarvad, olysonek
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-07-12 08:57:31 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:
Description Flags
Logs none

Description Maryna Nalbandian 2018-08-02 07:47:15 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 acpid

Comment 1 Maryna Nalbandian 2018-08-02 07:47:31 UTC
Created attachment 1472303 [details]
Logs

Comment 2 Jan Kurik 2018-08-14 10:53:00 UTC
This bug appears to have been reported against 'rawhide' during the Fedora 29 development cycle.
Changing version to '29'.

Comment 3 Jaroslav Škarvada 2019-07-12 08:56:39 UTC
> Current version of package:
> acpid-2.0.29-1.fc29.x86_64
> 
> checking whether binary files have man pages:
> 
> [ [1m[32mOK(B[m ] binary /usr/bin/acpi_listen has man page /usr/share/man/man8/acpi_listen.8.gz
> [ [1m[33mWarn(B[m ] 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

It requires admin privileges.

> [ [1m[32mOK(B[m ] binary /usr/sbin/acpid has man page /usr/share/man/man8/acpid.8.gz
> [ [1m[33mWarn(B[m ] 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

It's daemon.

> [ [1m[32mOK(B[m ] binary /usr/sbin/kacpimon has man page /usr/share/man/man8/kacpimon.8.gz
> [ [1m[33mWarn(B[m ] 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

It requires admin privileges

> checking whether config files have man pages:
> 
> [ [1m[31mError(B[m ] config file /etc/acpi/actions/power.sh has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/acpi/events/powerconf has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/acpi/events/videoconf has no man page! Check it's content for proper documentation

The /etc/acpi directory tree is described in acpid manual page.

> [ [1m[31mError(B[m ] config file /etc/sysconfig/acpid has no man page! Check it's content for proper documentation

Generic service configuration file, it doesn't need manual page.

Comment 4 Jaroslav Škarvada 2019-07-12 08:57:31 UTC
Closing as notabug according to comment 3.