Bug 1611291
| Summary: | Man page scan results for gawk | ||||||
|---|---|---|---|---|---|---|---|
| Product: | [Fedora] Fedora | Reporter: | Maryna Nalbandian <mnalband> | ||||
| Component: | gawk | Assignee: | David Kaspar // Dee'Kej <deekej> | ||||
| Status: | CLOSED WONTFIX | QA Contact: | Fedora Extras Quality Assurance <extras-qa> | ||||
| Severity: | medium | Docs Contact: | |||||
| Priority: | medium | ||||||
| Version: | rawhide | CC: | ajschorr, deekej, dkutalek, fpokorny, ovasik | ||||
| 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-03 09:11:17 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 1472434 [details]
Logs
Hello Andrew, the report mentions missing man pages for gawk.sh and gawk.csh files in /etc/profile.d. Do you think these should have a man page, or can we close this BZ? :) P.S.: It also found some duplicate words in man pages, but that's nothing important. I personally don't think there should be man pages for these. They are documented in the info docs. What section would a man page go in anyway? (In reply to Andrew Schorr from comment #3) > I personally don't think there should be man pages for these. They are > documented in the info docs. What section would a man page go in anyway? If you would like to document those, then the man pages would go to section 5 (many files from /etc/ folder are documented there). But if you say you're okay with just the info pages, then we can close this BZ I guess. :) There are many files in /etc/profile.d. I can see at least one example that is documented in a man page (try "man cvs.sh"), but I can also see several that are not documented, e.g. /etc/profile.d/which.sh and /etc/profile.d/ccache.sh. I think this is a power user feature, and those users should be able to access the info docs. The info documentation is much more extensive than the man page... Sure, no problem. :) |
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 gawk