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 1612210 - Man page scan results for openhpi
Summary: Man page scan results for openhpi
Keywords:
Status: CLOSED RAWHIDE
Alias: None
Product: Fedora
Classification: Fedora
Component: openhpi
Version: rawhide
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ---
Assignee: Dan Horák
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks: FedoraManpagescan
TreeView+ depends on / blocked
 
Reported: 2018-08-03 16:17 UTC by Maryna Nalbandian
Modified: 2018-08-07 14:22 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-08-07 14:22:40 UTC
Type: ---
Embargoed:

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

Description Maryna Nalbandian 2018-08-03 16:17:46 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 openhpi
Comment 1 Maryna Nalbandian 2018-08-03 16:18:05 UTC 
Created attachment 1473093 [details]
Logs
Comment 2 Than Ngo 2018-08-07 14:22:40 UTC 
>checking whether config files have man pages:

>[ ESC[1mESC[31mErrorESC(BESC[m ] config file /etc/openhpi/openhpi.conf has no >man page! Check it's content for proper documentation

keywords are well described within the openhpi.conf 

>[ ESC[1mESC[31mErrorESC(BESC[m ] config file /etc/openhpi/openhpiclient.conf >has no man page! Check it's content for proper documentation

keywords are well described within openhpiclient.conf 


>[ ESC[1mESC[31mErrorESC(BESC[m ] config file /etc/openhpi/simulation.data has >no man page! Check it's content for proper documentation

/usr/share/doc/openhpi/README-dynamic_simulator contains documentation (it will be added in next build)

>[ ESC[1mESC[32mOKESC(BESC[m ] binary /usr/sbin/openhpid has man page >/usr/share/man/man8/openhpid.8.gz
>[ ESC[1mESC[33mWarnESC(BESC[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

openhpid is daemon, it's correct to install the man page in section 8


>Program path:                                                                                                                                     
>        /usr/bin/hpialarms
>Man pages found:
>        /usr/share/man/man1/hpialarms.1.gz
>The binary analysis was NOT done
>Doing man page vs. usage message comparison
>The program reported 26 option(s)
>The man page reported 34 option(s)
>0 option(s) reported by the program ONLY:
>8 option(s) reported by the man page ONLY:
>        -all
>        -chassisid
>        -critical
>        -diska
>        -diskb
>        -major
>        -minor
>        -power
8 options are reported by problem too, but were not recognized correctly by man page scan ->  false povitive


>Program path:
>        /usr/bin/hpicrypt
>Man pages found:
>        /usr/share/man/man1/hpicrypt.1.gz
>The binary analysis was NOT done
>Doing man page vs. usage message comparison
>
>The program reported 4 option(s)
>The man page reported 2 option(s)
>2 COMMON option(s):
>        -c
>        -d
>2 option(s) reported by the program ONLY:
>        --help
>        --usage
>0 option(s) reported by the man page ONLY:

option -d is reported by program, but option -c is missing and be added in next build.

>Program path:
>        /usr/bin/hpitop
>Man pages found:
>        /usr/share/man/man1/hpitop.1.gz
>The binary analysis was NOT done
>Doing man page vs. usage message comparison
>0 option(s) reported by the program ONLY:
>1 option(s) reported by the man page ONLY:
>        -rscwiafd

it's fixed in next rebuild

>Program path:
>        /usr/bin/hpitree
>Man pages found:
>        /usr/share/man/man1/hpitree.1.gz
>The binary analysis was NOT done
>Doing man page vs. usage message comparison
>
>1 option(s) reported by the program ONLY:
>        -cdirs
>1 option(s) reported by the man page ONLY:
>        -acdiorsw

the options -acdiorsw are reported by program but not regozined by man page scan -> false positive.

>Program path:
>        /usr/sbin/openhpid
>Man pages found:
>        /usr/share/man/man8/openhpid.8.gz
>The binary analysis was NOT done
>Doing man page vs. usage message comparison
>
>The program reported 24 option(s)
>The man page reported 20 option(s)
>4 option(s) reported by the program ONLY:
>        --decrypt
>        --help
>        -d
>        -h
>0 option(s) reported by the man page ONLY:

both missing options are fixed in new build openhpi-3.8.0-5.fc29
Note You need to log in before you can comment on or make changes to this bug.