terraform/website/source/docs/commands
Dan Carley 64c1280951 command/fmt: Improve documentation for -diff and defaults (#6398)
* command/fmt: Document -diff doesn't disable -write

As noted in hashicorp/terraform#6343, this description misleadingly
suggested that the `-diff` option disables the `-write` option.

This isn't the case and because of the default options (described in
c753390) the behaviour of `terraform fmt -diff` is actually the same as
`terraform fmt -write -list -diff`.

Replace the "instead of rewriting" description to clarify that.

Documentation in hcl/fmtcmd is corrected in hashicorp/hcl#117 but it's not
really necessary to bump the dependency version.

* command/fmt: Show flag defaults in help text

These were documented on the website but not in the `-help` text. This
should help to clarify that you need to pass `-list=false -write=false
-diff` if you only want to see diffs.

Accordingly I've replaced the word "disabled" with "always false" in the
STDIN special cases so that it matches the terminology used in the defaults
and better indicates that it is overridden.

NB: The 3x duplicated defaults and documentation makes me feel uneasy once
again. I'm not sure how to solve that, though.
2016-04-29 00:39:53 +01:00
..
apply.html.markdown docs(variables): describe order of evaluation with files 2016-03-01 17:08:57 -06:00
destroy.html.markdown docs: clarify wording around destroy/apply args 2015-06-17 10:10:23 -05:00
fmt.html.markdown command/fmt: Improve documentation for -diff and defaults (#6398) 2016-04-29 00:39:53 +01:00
get.html.markdown Add meta descriptions to all pages 2014-10-21 23:21:56 -04:00
graph.html.markdown command: Change module-depth default to -1 2016-01-20 13:58:02 -06:00
index.html.markdown Added verify command 2016-02-08 12:48:14 +01:00
init.html.markdown Fix broken link 2016-01-14 17:13:14 -05:00
output.html.markdown Update docs 2015-05-27 17:11:31 +02:00
plan.html.markdown docs(variables): describe order of evaluation with files 2016-03-01 17:08:57 -06:00
push.html.markdown docs(variables): redundant wording 2016-03-01 17:13:05 -06:00
refresh.html.markdown docs(variables): describe order of evaluation with files 2016-03-01 17:08:57 -06:00
remote-config.html.markdown docs: Create new section for remote state backends 2016-01-18 08:08:19 +00:00
remote-pull.html.markdown website: docs for new remote commands 2015-03-04 16:35:42 -08:00
remote-push.html.markdown website: docs for new remote commands 2015-03-04 16:35:42 -08:00
remote.html.markdown Typo fix. 2015-03-13 17:37:05 -06:00
show.html.markdown command: Change module-depth default to -1 2016-01-20 13:58:02 -06:00
taint.html.markdown command/taint: -allow-missing 2015-02-26 10:56:45 -08:00
untaint.html.markdown command: Add `terraform untaint` 2016-03-11 12:38:57 -06:00
validate.html.markdown docs: Clarify use cases in docs for the validate cmd 2016-02-08 12:36:30 +00:00