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 1611291 - Man page scan results for gawk
Summary: Man page scan results for gawk
Keywords:
Status: CLOSED WONTFIX
Alias: None
Product: Fedora
Classification: Fedora
Component: gawk
Version: rawhide
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ---
Assignee: David Kaspar // Dee'Kej
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks: FedoraManpagescan
TreeView+ depends on / blocked
 
Reported: 2018-08-02 08:28 UTC by Maryna Nalbandian
Modified: 2018-08-03 09:11 UTC (History)
5 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-08-03 09:11:17 UTC
Type: ---
Embargoed:

Attachments (Terms of Use)
Logs (3.32 KB, text/plain)
2018-08-02 08:29 UTC, Maryna Nalbandian 		no flags Details
View All

Description Maryna Nalbandian 2018-08-02 08:28:50 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 gawk
Comment 1 Maryna Nalbandian 2018-08-02 08:29:06 UTC 
Created attachment 1472434 [details]
Logs
Comment 2 David Kaspar // Dee'Kej 2018-08-02 09:02:51 UTC 
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.
Comment 3 Andrew Schorr 2018-08-02 14:44:02 UTC 
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?
Comment 4 David Kaspar // Dee'Kej 2018-08-02 19:26:49 UTC 
(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. :)
Comment 5 Andrew Schorr 2018-08-02 19:37:47 UTC 
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...
Comment 6 David Kaspar // Dee'Kej 2018-08-03 09:11:17 UTC 
Sure, no problem. :)
Note You need to log in before you can comment on or make changes to this bug.