Add a note about TERRAFORM_CONFIG to help with migration of very old configurations.

Per the description, a user was confused about the usage and lack of documentation around TERRAFORM_CONFIG. It would help newer users update old configs if this was documented in some fashion.
2 years ago · 4afdd94390
parent df738d498d
commit 4afdd94390
1 changed files with 2 additions and 0 deletions
--- a/website/docs/cli/config/environment-variables.mdx
+++ b/website/docs/cli/config/environment-variables.mdx
@ -151,6 +151,8 @@ The location of the [Terraform CLI configuration file](/terraform/cli/config/con
 export TF_CLI_CONFIG_FILE="$HOME/.terraformrc-custom"
 ```

+(Note that `TERRAFORM_CONFIG` is a deprecated alias for this variable. Please do not use `TERRAFORM_CONFIG` as it may be removed in future versions of Terraform.)
+
 ## TF_PLUGIN_CACHE_DIR

 The `TF_PLUGIN_CACHE_DIR` environment variable is an alternative way to set [the `plugin_cache_dir` setting in the CLI configuration](/terraform/cli/config/config-file#provider-plugin-cache).