From f6585318837a6a4fda0c5bec9aa96390f14ea5df Mon Sep 17 00:00:00 2001 From: Andor Markus Date: Wed, 11 Nov 2020 23:21:21 +0100 Subject: [PATCH 1/2] Updating terraform workspace website list.html.md new.html.md select.html.md files thus it reflect the current version of Terraform CLI --- website/docs/cli/commands/workspace/list.html.md | 2 +- website/docs/cli/commands/workspace/new.html.md | 6 ++++-- website/docs/cli/commands/workspace/select.html.md | 2 +- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/website/docs/cli/commands/workspace/list.html.md b/website/docs/cli/commands/workspace/list.html.md index 0b0f842a1..2114a60c6 100644 --- a/website/docs/cli/commands/workspace/list.html.md +++ b/website/docs/cli/commands/workspace/list.html.md @@ -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. diff --git a/website/docs/cli/commands/workspace/new.html.md b/website/docs/cli/commands/workspace/new.html.md index 7b76b0cbc..f2bf10afe 100644 --- a/website/docs/cli/commands/workspace/new.html.md +++ b/website/docs/cli/commands/workspace/new.html.md @@ -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. @@ -22,7 +22,9 @@ will be copied to initialize the state for this new workspace. The command-line flags are all optional. The only supported flag is: -* `-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 diff --git a/website/docs/cli/commands/workspace/select.html.md b/website/docs/cli/commands/workspace/select.html.md index eaadd59b6..08170a61e 100644 --- a/website/docs/cli/commands/workspace/select.html.md +++ b/website/docs/cli/commands/workspace/select.html.md @@ -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. From 6da55c05217524e9989c12298040c0513a9b8593 Mon Sep 17 00:00:00 2001 From: Pam Selle <204372+pselle@users.noreply.github.com> Date: Tue, 26 Jan 2021 11:34:48 -0500 Subject: [PATCH 2/2] Update grammar for flags --- website/docs/cli/commands/workspace/new.html.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/cli/commands/workspace/new.html.md b/website/docs/cli/commands/workspace/new.html.md index f2bf10afe..0caac8b08 100644 --- a/website/docs/cli/commands/workspace/new.html.md +++ b/website/docs/cli/commands/workspace/new.html.md @@ -20,7 +20,7 @@ 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: * `-lock` - Lock the state file when locking is supported. Defaults to true. * `-lock-timeout` - Duration to retry a state lock. Default 0s.