Bug 1542883
| Summary: | cal man page uses incorrect synopsis syntax | ||
|---|---|---|---|
| Product: | [Fedora] Fedora | Reporter: | Wayne Pollock <pollock> |
| Component: | util-linux | Assignee: | Karel Zak <kzak> |
| Status: | CLOSED UPSTREAM | QA Contact: | Fedora Extras Quality Assurance <extras-qa> |
| Severity: | low | Docs Contact: | |
| Priority: | unspecified | ||
| Version: | 27 | CC: | jonathan, kzak |
| 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-02-07 09:53:26 UTC | Type: | Bug |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
| Embargoed: | |||
Good point. We do not use '{ }' in util-linux. It seems better to use
cal [ options ] [timestamp|monthname]
to be compatible with another our man pages. I'll fix it in upstream tree. Thanks!
Note that timestamp and monthname are not required, all is optional. |
Description of problem: The cal man page uses "<" and ">" for grouping. The standard since forever (and still documented in the current SUS/POSIX standard) is to use "{" and "}" for grouping when one of several items is required. Version-Release number of selected component (if applicable): How reproducible: Steps to Reproduce: 1. man cal 2. 3. Actual results: cal [options] <timestamp|monthname> Expected results: cal [ options ] { timestamp | monthname } Additional info: The Fedora 27 man(1) and man-pages(7) don't document any grouping syntax, except for "[" and "]". They should probably have a sentence added; let me know if the assignee needs me to create a separate bug for those man pages. (I realize this is extremely low priority, but should be a very quick painless fix. Correct documentation syntax is important to new users.)