From f01d08f6e9073f0bbdb418f7a9d8f31d97ddc3b3 Mon Sep 17 00:00:00 2001 From: Frank Villaro-Dixon Date: Mon, 24 Jul 2023 11:55:56 +0200 Subject: [PATCH] website: doc: fmt: specify "no flag" action Signed-off-by: Frank Villaro-Dixon --- website/docs/cli/commands/fmt.mdx | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/website/docs/cli/commands/fmt.mdx b/website/docs/cli/commands/fmt.mdx index 4b2661ad2a..9dbe2aa827 100644 --- a/website/docs/cli/commands/fmt.mdx +++ b/website/docs/cli/commands/fmt.mdx @@ -53,7 +53,11 @@ directory instead. If you provide a file, then `fmt` will process just that file. If you provide a single dash (`-`), then `fmt` will read from standard input (STDIN). -The command-line flags are all optional. The following flags are available: + +The command-line flags are all optional. If no flag is given, `fmt` rewrites +the Terraform configuration files to a canonical format and style. + +The following flags are available: * `-list=false` - Don't list the files containing formatting inconsistencies. * `-write=false` - Don't overwrite the input files. (This is implied by `-check` or when the input is STDIN.)