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 1612231 - Man page scan results for postfix
Summary: Man page scan results for postfix
Keywords:
Status: CLOSED NOTABUG
Alias: None
Product: Fedora
Classification: Fedora
Component: postfix
Version: 29
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ---
Assignee: Jaroslav Škarvada
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks: FedoraManpagescan
TreeView+ depends on / blocked
 
Reported: 2018-08-03 16:25 UTC by Maryna Nalbandian
Modified: 2019-07-12 11:21 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-07-12 11:21:44 UTC
Type: ---
Embargoed:


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

Description Maryna Nalbandian 2018-08-03 16:25:42 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 postfix

Comment 1 Maryna Nalbandian 2018-08-03 16:25:59 UTC
Created attachment 1473114 [details]
Logs

Comment 2 Jan Kurik 2018-08-14 10:36:59 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 11:21:44 UTC
> [  [1m[31mError(B[m ] binary /usr/bin/rmail has no man page!
> [ [1m[31mError(B[m ] binary /usr/bin/rmail.postfix has no man page!
>
No manual page exists.

> [ [1m[32mOK(B[m ] binary /usr/sbin/sendmail has man page /usr/share/man/man8/sendmail.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 is daemon.

> [ [1m[32mOK(B[m ] config file /etc/pam.d/smtp has man page /usr/share/man/man8/smtp.8.gz
> [ [1m[31mError(B[m ] man page is in unexpected section 8. Man pages for configuration files should be in section 5
>
False positive it's manual page for SMTP+LMTP client.

> [ [1m[31mError(B[m ] config file /etc/pam.d/smtp.postfix has no man page! Check it's content for proper documentation
>
No manual page exists.

> [ [1m[33mWarn(B[m ] these (44) man pages left unassigned:
>
Probably OK.

> checking /usr/share/man/man5/postconf.5.gz:
> [ [1m[32mOK(B[m ] man page parsing with lexgrog succeeded
> [ [1m[33mWarn(B[m ] found repeated words in man page: number number type:table 
>
It seems like false positive.

> checking /usr/share/man/man5/virtual.5.gz:
> [ [1m[32mOK(B[m ] man page parsing with lexgrog succeeded
> [ [1m[33mWarn(B[m ] found repeated words in man page: address, address, address, address, 
>
False positive.


Note You need to log in before you can comment on or make changes to this bug.