terraform/website/source/docs
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
..
commands command/fmt: Improve documentation for -diff and defaults (#6398) 2016-04-29 00:39:53 +01:00
configuration config: new interpolation function jsonencode 2016-03-29 07:38:58 -07:00
internals docs: Add a section to Debugging docs about crash logs 2016-03-18 18:10:26 -05:00
modules command: Change module-depth default to -1 2016-01-20 13:58:02 -06:00
plugins Added a cast to "(*schema.Provider)" in the standard TestProvider function 2016-03-06 19:16:34 -03:00
providers Clean up cloudfront docs and remove extraneous a tags (#6405) 2016-04-29 00:28:45 +01:00
provisioners Fixed typos in remote.html.markdown and connection.html.markdown. (#6195) 2016-04-15 23:05:49 +01:00
state docs/remote-state/s3: Fix typo 2016-01-25 22:16:25 +00:00
index.html.markdown Add meta descriptions to all pages 2014-10-21 23:21:56 -04:00