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 1612272
| Summary: | Man page scan results for sgml-common | ||||||
|---|---|---|---|---|---|---|---|
| Product: | [Fedora] Fedora | Reporter: | Maryna Nalbandian <mnalband> | ||||
| Component: | sgml-common | Assignee: | Ondrej Vasik <ovasik> | ||||
| Status: | CLOSED RAWHIDE | QA Contact: | Fedora Extras Quality Assurance <extras-qa> | ||||
| Severity: | low | Docs Contact: | |||||
| Priority: | low | ||||||
| Version: | 29 | CC: | dkutalek, ovasik | ||||
| Target Milestone: | --- | ||||||
| Target Release: | --- | ||||||
| Hardware: | Unspecified | ||||||
| OS: | Unspecified | ||||||
| Whiteboard: | |||||||
| Fixed In Version: | sgml-common-0.6.3-51.fc30 | Doc Type: | If docs needed, set a value | ||||
| Doc Text: | Story Points: | --- | |||||
| Clone Of: | Environment: | ||||||
| Last Closed: | 2018-10-05 13:00:56 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 1473154 [details]
Logs
Thanks for checking the package. I believe man page section 8 for /usr/bin/install-catalog is justified, as it is not supposed to be used by users - it modifies /etc/sgml/ catalogs - that are handled from spec files or by admin. Upstream has this in section 8 and I'm not going to change this. /etc/sgml/catalog is catalog file, not intended by usage by humans. It lists the catalogs registered by install-catalog binary. No reason for man page there. /etc/sgml/sgml.conf - default settings for sgml - however, this can probably be documented. I've found some documentation for the possible settings at ftp://ftp.lyx.org/pub/sgml-tools/website/docs/sgml-dir-standard/t0102.html , so this could possibly be used as an inspiration for the initial man-page. It would be downstream only, though - as there were no changes in sgml-common - as there is no longer active development since 2001. sgmlwhich is just simple script that returns one string with location of sgml dir :) , it is documented in the script itself, but having downstream manpage wouldn't hurt... Nothing critical, nice to have at maximum, though... as nobody requested them for ages... This bug appears to have been reported against 'rawhide' during the Fedora 29 development cycle. Changing version to '29'. |
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 sgml-common