Bug 1440620
Summary: | The help info of clear route status script need to be more specific | ||
---|---|---|---|
Product: | OpenShift Container Platform | Reporter: | Yan Du <yadu> |
Component: | Networking | Assignee: | Jacob Tanenbaum <jtanenba> |
Networking sub component: | router | QA Contact: | zhaozhanqi <zzhao> |
Status: | CLOSED ERRATA | Docs Contact: | Jacob Tanenbaum <jtanenba> |
Severity: | low | ||
Priority: | medium | CC: | aos-bugs, bbennett, jtanenba, yadu |
Version: | 3.5.1 | ||
Target Milestone: | --- | ||
Target Release: | 3.7.0 | ||
Hardware: | Unspecified | ||
OS: | Unspecified | ||
Whiteboard: | |||
Fixed In Version: | Doc Type: | Bug Fix | |
Doc Text: |
Cause:
The help info included included a redundant example
Consequence:
The help info was more verbose then required
Fix:
removed redundant example
Result:
The help info is more concise
|
Story Points: | --- |
Clone Of: | Environment: | ||
Last Closed: | 2017-11-28 21:53:29 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
Yan Du
2017-04-10 06:21:27 UTC
The upper portion of the help text is general usage and the lower portions are usage examples. Would labelling the lower section of the help text as examples suffice? I don't think they should be removed. However the lines: To clear the whole status field of the route by route name ./clear-route-status.sh [namespace] [route-name | ALL] Should be changed to: To clear the status field of a route or all routes in a given namespace ./clear-route-status.sh [namespace] [route-name | ALL] OK, that makes sense, thanks for your clarification. Commit pushed to master at https://github.com/openshift/origin https://github.com/openshift/origin/commit/1599d80807ec4f1940b0dea39f52d737cb4fb625 fix the help text in the clear-route-status script QA reported that they felt the help text was not clear enough. I Tagged the examples as examples and reworded a section Bug: 1440620 Help info looks good: [root@host-8-174-34 ~]# ./clear-route-status.sh -h Usage: To clear only the status set by a specific router on all routes in all namespaces ./clear-router-status.sh -r [router_name] router_name is the name in the deployment config, not the name of the pod. If the router is running it will immediately update any cleared status. To clear the status field of a route or all routes in a given namespace ./clear-route-status.sh [namespace] [route-name | ALL] Please move bug to ON_QA, then qe could verify it. Thanks The help info looks good to me. Move the bug to verify. [root@openshift-master /]# ./clear-route-status.sh Usage: To clear only the status set by a specific router on all routes in all namespaces ./clear-router-status.sh -r [router_name] router_name is the name in the deployment config, not the name of the pod. If the router is running it will immediately update any cleared status. To clear the status field of a route or all routes in a given namespace ./clear-route-status.sh [namespace] [route-name | ALL] Since the problem described in this bug report should be resolved in a recent advisory, it has been closed with a resolution of ERRATA. For information on the advisory, and where to find the updated files, follow the link below. If the solution does not work for you, open a new bug report. https://access.redhat.com/errata/RHSA-2017:3188 |