Skip to content

Commit 89351d4

Browse files
authored
Merge pull request #299 from markcocker/dev
Add doc for return code
2 parents e7d4f6a + 770697a commit 89351d4

File tree

3 files changed

+14
-9
lines changed

3 files changed

+14
-9
lines changed

docs/pages/cdp/cdp-Creating-Zowe-CLI-profiles.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,7 @@ folder: cdp
99
toc: false
1010
---
1111

12-
The Zowe CLI lets you define arguments and options for commands in multiple ways, with the following order of precedence:
13-
14-
1. Command-line
15-
2. Environment variables
16-
3. Profiles
17-
18-
Therefore by creating and setting options in the following profiles, they will become your defaults and you do not need to repeat them when using Zowe CLI commands unless you wish to override them. Further details are in [Understanding command option order of precedence](https://zowe.github.io/docs-site/latest/user-guide/cli-configuringcli.html#understanding-command-option-order-of-precedence).
12+
See [Zowe CLI profiles](cdp-zowe-profiles) for an overview of profiles.
1913

2014
The CICS® deploy plug-in makes use of the following profiles:
2115

docs/pages/cdp/cdp-Deploying-using-individual-actions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The `zowe cics-deploy push bundle` command performs a set of actions to deploy a
1616
* resolve Node.js application dependencies on z/OS
1717
* deploy the CICS bundle in CICS
1818

19-
However, there may be situations where you need more control of these actions or perform alternate actions. The following sections describe how each of these actions can be performed independently, enabling you to form a sequence of commands to achieve your needs.
19+
However, there may be situations where you need more control of these actions or perform alternate actions. The following sections describe how each of these actions can be performed independently, enabling you to form a sequence of commands to achieve your needs. Zowe CLI commands set the return code to 0 when the command completed successfully, or greater than 0 if the command failed.
2020

2121
### Undeploy a CICS bundle
2222

docs/pages/cdp/cdp-Zowe-CLI-profiles.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,20 @@ As suggested above, to deploy a Node.js application from your workstation to one
4747

4848
Ultimately, you are not *required* to use Zowe CLI profiles - you can specify all of the required command-line arguments explicitly - but they reduce the burden of typing when you are issuing commands that require many arguments.
4949

50+
### Order of precedence
51+
52+
The Zowe CLI lets you define arguments and options for commands in multiple ways, with the following order of precedence:
53+
54+
1. Command-line
55+
2. Environment variables
56+
3. Profiles
57+
58+
Therefore by setting options in a profile they will become your default and you do not need to repeat them on the command-line unless you wish to override them. Further details are in [Understanding command option order of precedence](https://zowe.github.io/docs-site/latest/user-guide/cli-configuringcli.html#understanding-command-option-order-of-precedence).
59+
5060
### Where are Zowe CLI profiles stored?
5161

52-
When you create a Zowe CLI profile, a representation is written to an operating-system-dependent text file on your local workstation.
62+
When you create a Zowe CLI profile, a representation is written to a file on your local workstation in plain text. This file may contain sensitive information such as user IDs and passwords and therefore needs to be secured. Further details are in [Creating Zowe CLI profiles](https://zowe.github.io/docs-site/latest/user-guide/cli-configuringcli.html#creating-zowe-cli-profiles).
63+
5364
<ul id="profileTabs" class="nav nav-tabs">
5465
<li class="active"><a href="#windows" data-toggle="tab">Windows</a></li>
5566
<li><a href="#linux" data-toggle="tab">Linux</a></li>

0 commit comments

Comments
 (0)