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 1612270 - Man page scan results for sendmail
Summary: Man page scan results for sendmail
Keywords:
Status: CLOSED NOTABUG
Alias: None
Product: Fedora
Classification: Fedora
Component: sendmail
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:39 UTC by Maryna Nalbandian
Modified: 2019-07-16 09:24 UTC (History)
5 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-07-16 09:24:02 UTC
Type: ---
Embargoed:

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

Description Maryna Nalbandian 2018-08-03 16:39:43 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 sendmail
Comment 1 Maryna Nalbandian 2018-08-03 16:40:02 UTC 
Created attachment 1473151 [details]
Logs
Comment 2 Jan Kurik 2018-08-14 10:35:14 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-16 09:24:02 UTC 
> [ [1m[32mOK(B[m ] binary /usr/bin/hoststat has man page /usr/share/man/man8/hoststat.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
> [ [1m[32mOK(B[m ] binary /usr/bin/makemap has man page /usr/share/man/man8/makemap.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
> [ [1m[32mOK(B[m ] binary /usr/bin/purgestat has man page /usr/share/man/man8/purgestat.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
> [ [1m[32mOK(B[m ] binary /usr/bin/rmail has man page /usr/share/man/man8/rmail.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
> [ [1m[32mOK(B[m ] binary /usr/bin/rmail.sendmail has man page /usr/share/man/man8/rmail.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
> [ [1m[32mOK(B[m ] binary /usr/sbin/editmap has man page /usr/share/man/man8/editmap.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
> [ [1m[32mOK(B[m ] binary /usr/sbin/editmap.sendmail has man page /usr/share/man/man8/editmap.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
> [ [1m[32mOK(B[m ] binary /usr/sbin/mailstats has man page /usr/share/man/man8/mailstats.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
> [ [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
> [ [1m[32mOK(B[m ] binary /usr/sbin/praliases has man page /usr/share/man/man8/praliases.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
> [ [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
> [ [1m[32mOK(B[m ] binary /usr/sbin/sendmail.sendmail has man page /usr/share/man/man8/sendmail.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
> [ [1m[32mOK(B[m ] binary /usr/sbin/smrsh has man page /usr/share/man/man8/smrsh.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

In fact all commands are intended to be run by admin. The hoststat, purgestat are symlinks to sendmail manual page. We could probably move the commands from bin to sbin, but I think it's done this way for backward compatibility, so I will not change it downstream.

> checking whether config files have man pages:
> 
> [ [1m[31mError(B[m ] config file /etc/NetworkManager/dispatcher.d/10-sendmail has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/mail/Makefile has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/mail/access has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/mail/access.db has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/mail/aliasesdb-stamp has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/mail/domaintable has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/mail/domaintable.db has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/mail/helpfile has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/mail/local-host-names has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/mail/mailertable has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/mail/mailertable.db has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/mail/make has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/mail/sendmail.cf has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/mail/sendmail.mc has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/mail/submit.cf has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/mail/submit.mc has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/mail/trusted-users has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/mail/virtusertable has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/mail/virtusertable.db has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/pam.d/smtp has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/pam.d/smtp.sendmail has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/sasl2/Sendmail.conf has no man page! Check it's content for proper documentation
> [ [1m[31mError(B[m ] config file /etc/sysconfig/sendmail has no man page! Check it's content for proper documentation
>
No manual page exists, I think it's not worth to create them - most of the files are covered in detail by the Sendmail Operation Guide or in documentation shipped with sendmail.

> checking /usr/share/man/man8/sendmail.sendmail.8.gz:
> [ [1m[32mOK(B[m ] man page parsing with lexgrog succeeded
> [ [1m[33mWarn(B[m ] found repeated words in man page: option 

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