Bug 1612335

Summary: Man page scan results for zsh
Product: [Fedora] Fedora Reporter: Maryna Nalbandian <mnalband>
Component: zshAssignee: Kamil Dudka <kdudka>
Status: CLOSED NOTABUG QA Contact: Fedora Extras Quality Assurance <extras-qa>
Severity: medium Docs Contact:
Priority: medium    
Version: rawhideCC: dkutalek, dmaphy, james.antill, j, kdudka, svashisht
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: 2018-08-10 16:03:23 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-03 17:02:37 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 zsh
Comment 1 Maryna Nalbandian 2018-08-03 17:02:57 UTC 
Created attachment 1473217 [details]
Logs
Comment 2 Kamil Dudka 2018-08-10 16:03:23 UTC 
> [ Error ] config file /etc/skel/.zshrc has no man page! Check it's content for proper documentation
> [ Error ] config file /etc/zlogin has no man page! Check it's content for proper documentation
> [ Error ] config file /etc/zlogout has no man page! Check it's content for proper documentation
> [ Error ] config file /etc/zprofile has no man page! Check it's content for proper documentation
> [ Error ] config file /etc/zshenv has no man page! Check it's content for proper documentation
> [ Error ] config file /etc/zshrc has no man page! Check it's content for proper documentation

All the files in /etc are documented in themselves.  See their contents.

All the warnings are false positives, as far as I can tell.

zsh is a shell interpreter, which has the corresponding zsh(1) man page entry.  All the other man pages in section 1 are referred from the top-level zsh(1) man page.