From fef57279043d0e474448c9fb5d5ee6196a96ad32 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Thu, 24 Nov 2016 09:22:18 -0800 Subject: [PATCH] Remind future maintainers to update the docs when changing CLI usage We have a copy of the output from running just "terraform" in a page on the website. It doesn't necessarily need to be kept 100% up to date, since users can always run the command to get the result from the horses mouth, but it's nice to keep it somewhat up-to-date to reduce use confusion. --- commands.go | 6 ++++++ help.go | 3 +++ 2 files changed, 9 insertions(+) diff --git a/commands.go b/commands.go index fd8b0c57a..dbffe9b7a 100644 --- a/commands.go +++ b/commands.go @@ -35,6 +35,12 @@ func init() { Ui: Ui, } + // The command list is included in the terraform -help + // output, which is in turn included in the docs at + // website/source/docs/commands/index.html.markdown; if you + // add, remove or reclassify commands then consider updating + // that to match. + PlumbingCommands = map[string]struct{}{ "state": struct{}{}, // includes all subcommands "debug": struct{}{}, // includes all subcommands diff --git a/help.go b/help.go index 0358942ec..cd4e6714b 100644 --- a/help.go +++ b/help.go @@ -28,6 +28,9 @@ func helpFunc(commands map[string]cli.CommandFactory) string { } } + // The output produced by this is included in the docs at + // website/source/docs/commands/index.html.markdown; if you + // change this then consider updating that to match. helpText := fmt.Sprintf(` Usage: terraform [--version] [--help] [args]