Merge pull request #23815 from pselle/docs/module-depth

(docs) Update docs to reflect current behavior for module-depth
This commit is contained in:
Pam Selle 2020-01-09 10:10:00 -05:00 committed by GitHub
commit 94ab6d00ae
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 6 deletions

View File

@ -191,12 +191,11 @@ Options:
-draw-cycles Highlight any cycles in the graph with colored edges. -draw-cycles Highlight any cycles in the graph with colored edges.
This helps when diagnosing cycle errors. This helps when diagnosing cycle errors.
-module-depth=n Specifies the depth of modules to show in the output.
By default this is -1, which will expand all.
-type=plan Type of graph to output. Can be: plan, plan-destroy, apply, -type=plan Type of graph to output. Can be: plan, plan-destroy, apply,
validate, input, refresh. validate, input, refresh.
-module-depth=n (deprecated) In prior versions of Terraform, specified the
depth of modules to show in the output.
` `
return strings.TrimSpace(helpText) return strings.TrimSpace(helpText)
} }

View File

@ -36,12 +36,12 @@ Options:
* `-draw-cycles` - Highlight any cycles in the graph with colored edges. * `-draw-cycles` - Highlight any cycles in the graph with colored edges.
This helps when diagnosing cycle errors. This helps when diagnosing cycle errors.
* `-module-depth=n` - Specifies the depth of modules to show in the output.
By default this is `-1`, which will expand all.
* `-type=plan` - Type of graph to output. Can be: `plan`, `plan-destroy`, `apply`, * `-type=plan` - Type of graph to output. Can be: `plan`, `plan-destroy`, `apply`,
`validate`, `input`, `refresh`. `validate`, `input`, `refresh`.
* `-module-depth=n` - (deprecated) In prior versions of Terraform, specified the
depth of modules to show in the output.
## Generating Images ## Generating Images
The output of `terraform graph` is in the DOT format, which can The output of `terraform graph` is in the DOT format, which can