Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Zowe CLI commands need to document their return codes #436

Open
Tracked by #1545
markcocker opened this issue May 31, 2019 · 3 comments
Open
Tracked by #1545

Zowe CLI commands need to document their return codes #436

markcocker opened this issue May 31, 2019 · 3 comments
Labels
bug Something isn't working priority-medium Not functioning - next quarter if capacity permits severity-medium Bug where workaround exists or that doesn't prevent the usage of Zowe. Just makes it more complex.

Comments

@markcocker
Copy link

The Zowe CLI commands are very useful when writing automation scripts. When writing scripts it is crucial to understand if the command completed successfully or failed, and sometimes what type of failure in order to take appropriate action.

As an example, zowe zos-uss issue ssh sets the return code to the same as that returned by the remote command.

All the Zowe CLI commands need to document their return codes in the command line help. For consistency it would be useful to have the possible return codes documented in a new section in the help.

@ChrisBoehmCA
Copy link
Contributor

Thanks. With the exception of the ssh command, all other commands return either 0 on success or 1 on failure. Maybe we should document that in some single location

@markcocker
Copy link
Author

I was thinking of man grep as an example. It has a "EXIT STATUS" section.

@awharn awharn added bug Something isn't working for-review To be reviewed in an Eng & Prod Mgmt meeting labels Sep 14, 2022
@github-actions
Copy link

Thank you for creating a bug report. If you haven't already, please ensure you have provided steps to reproduce it and as much context as possible.

@gejohnston gejohnston added the priority-low Legit issue but cosmetic or nice-to-have label Oct 11, 2022
@JTonda JTonda removed the for-review To be reviewed in an Eng & Prod Mgmt meeting label Mar 1, 2023
@zFernand0 zFernand0 added the severity-low Bug that makes the usage of the Zowe less convenient but doesn't impact key use cases label Mar 1, 2023
@adam-wolfe adam-wolfe added priority-medium Not functioning - next quarter if capacity permits severity-medium Bug where workaround exists or that doesn't prevent the usage of Zowe. Just makes it more complex. and removed priority-low Legit issue but cosmetic or nice-to-have severity-low Bug that makes the usage of the Zowe less convenient but doesn't impact key use cases labels Apr 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working priority-medium Not functioning - next quarter if capacity permits severity-medium Bug where workaround exists or that doesn't prevent the usage of Zowe. Just makes it more complex.
Projects
Status: Medium Priority
Development

No branches or pull requests

7 participants