Merge pull request #26891 from andormarkus/Update_workspace_docs

website: Updating terraform workspace docs
This commit is contained in:
Pam Selle 2021-01-26 11:45:18 -05:00 committed by GitHub
commit 552451547c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 7 additions and 5 deletions

View File

@ -12,7 +12,7 @@ The `terraform workspace list` command is used to list all existing workspaces.
## Usage
Usage: `terraform workspace list`
Usage: `terraform workspace list [DIR]`
The command will list all existing workspaces. The current workspace is
indicated using an asterisk (`*`) marker.

View File

@ -12,7 +12,7 @@ The `terraform workspace new` command is used to create a new workspace.
## Usage
Usage: `terraform workspace new [NAME]`
Usage: `terraform workspace new [OPTIONS] NAME [DIR]`
This command will create a new workspace with the given name. A workspace with
this name must not already exist.
@ -20,9 +20,11 @@ this name must not already exist.
If the `-state` flag is given, the state specified by the given path
will be copied to initialize the state for this new workspace.
The command-line flags are all optional. The only supported flag is:
The command-line flags are all optional. The supported flags are:
* `-state=path` - Path to a state file to initialize the state of this environment.
* `-lock` - Lock the state file when locking is supported. Defaults to true.
* `-lock-timeout` - Duration to retry a state lock. Default 0s.
* `-state=path` - Path to an existing state file to initialize the state of this environment.
## Example: Create

View File

@ -13,7 +13,7 @@ workspace to use for further operations.
## Usage
Usage: `terraform workspace select [NAME]`
Usage: `terraform workspace select NAME [DIR]`
This command will select another workspace. The named workspace must already
exist.