Bug 1352453

Summary: oc sub-command should remain useful help info from kubectl sub-command
Product: OpenShift Container Platform Reporter: Xingxing Xia <xxia>
Component: ocAssignee: Maciej Szulik <maszulik>
Status: CLOSED EOL QA Contact: Xingxing Xia <xxia>
Severity: low Docs Contact:
Priority: low    
Version: unspecifiedCC: aos-bugs, jokerman, mmccomas
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: 2019-08-21 09:07:11 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 Xingxing Xia 2016-07-04 08:04:16 UTC
Description of problem:
oc sub-command should remain useful help info from kubectl sub-command. Because for some sub-commands, `oc sub-command -h` trims the more detailed/clearer description/examples from kubectl, which may be important to user.
E.g.
oc proxy -h VS kubectl proxy -h
oc patch -h VS kubectl patch -h
oc run -h VS kubectl run -h

Version-Release number of selected component (if applicable):
oc v1.3.0-alpha.2-332-g8aaba51
kubernetes v1.3.0-alpha.3-599-g2746284

How reproducible:

Steps to Reproduce:
Just takes some sub-commands as instance:
1. oc proxy -h VS kubectl proxy -h
2. oc patch -h VS kubectl patch -h
3. oc run -h VS kubectl run -h

Actual results:
1.
See https://bugzilla.redhat.com/show_bug.cgi?id=1344877#c3 . Reference to bug 1344877 just wants to say, trimmed info in `oc proxy -h` causes user misunderstanding

2.
kubectl patch -h has more info than oc patch -h, such as more detailed examples about more flags

3.
kubectl run -h has more useful examples, such as about '--command` specified or not

Expected results:
oc sub-commands should remain useful help info from kubectl sub-command

Additional info:
Remaining useful help info from kubectl sub-command could be used TOGETHER with adding help info to oc. E.g. it is good for 'oc logs -h' to add statements about bc/build than 'kubectl logs -h'

Comment 2 Xingxing Xia 2017-06-30 10:58:27 UTC
FYI, https://bugzilla.redhat.com/show_bug.cgi?id=1466671#c1 point 2 indicates user may have less confusion and know correct usage directly from oc help info, if oc help info is fuller.

Comment 3 Maciej Szulik 2019-08-21 09:07:11 UTC
Closing due to age.