Bug 1420303

Summary:	[man] make commands syntax description consistent
Product:	Red Hat Enterprise Linux 7	Reporter:	Tomas Jelinek <tojeline>
Component:	pcs	Assignee:	Tomas Jelinek <tojeline>
Status:	CLOSED WONTFIX	QA Contact:	cluster-qe <cluster-qe>
Severity:	unspecified	Docs Contact:
Priority:	low
Version:	7.3	CC:	cfeist, cluster-maint, idevat, omular, tojeline
Target Milestone:	rc
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:	2021-01-15 07:31:37 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:

Description Tomas Jelinek 2017-02-08 12:02:49 UTC

There are no rules set of how a command parameters should be described in the man page and the buil-in help. Each command is described with a bit different syntax which may be confusing.
For example:
* variables: "arg" vs. "<arg>",
* possibility of repeating: "<arg> [arg]..." vs. "<arg>..." vs. "<arg> [arg] ... [arg]",
* mutually exclusive parameters: "[arg | arg]" vs. "[arg] | [arg]",
* and so on.

Comment 2 RHEL Program Management 2021-01-15 07:31:37 UTC

After evaluating this issue, there are no plans to address it further or fix it in an upcoming release.  Therefore, it is being closed.  If plans change such that this issue will be fixed in an upcoming release, then the bug can be reopened.