Bug 1611260
| Summary: | Man page scan results for environment-modules | ||||||
|---|---|---|---|---|---|---|---|
| Product: | [Fedora] Fedora | Reporter: | Maryna Nalbandian <mnalband> | ||||
| Component: | environment-modules | Assignee: | Jan Synacek <jsynacek> | ||||
| Status: | CLOSED NOTABUG | QA Contact: | Fedora Extras Quality Assurance <extras-qa> | ||||
| Severity: | medium | Docs Contact: | |||||
| Priority: | medium | ||||||
| Version: | 29 | CC: | dkutalek, jsynacek, praiskup | ||||
| 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-21 10:29:09 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: |
|
||||||
Created attachment 1472404 [details]
Logs
This bug appears to have been reported against 'rawhide' during the Fedora 29 development cycle. Changing version to '29'. Commenting on the important parts of the log: > [ [1m[31mError(B[m ] binary /usr/bin/envml has no man page! > [ [1m[31mError(B[m ] binary /usr/bin/modulecmd has no man page! Envml is a small bash script with a nice help message, there's no need to write a man page for it. Modulecmd is documented in module(1). > checking whether config files have man pages: > > [ [1m[31mError(B[m ] config file /etc/profile.d/modules.csh has no man page! Check it's content for proper documentation > [ [1m[31mError(B[m ] config file /etc/profile.d/modules.sh has no man page! Check it's content for proper documentation This check is bogus. It shouldn't complain about files under *.d/ not having man pages. |
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 environment-modules