Add documenation for HCPConfigMode type

3 years ago · 12e9316f94
parent 148d5e3a2d
commit 12e9316f94
1 changed files with 5 additions and 2 deletions
--- a/command/registry.go
+++ b/command/registry.go
@ -16,13 +16,16 @@ import (
 	"github.com/zclconf/go-cty/cty/gocty"
 )

+// HCPConfigMode types specify the mode in which HCP configuration
+// is defined for a given Packer build execution.
 type HCPConfigMode int

 const (
-	// HCPConfigMode types specify the mode in which HCP configuration
-	// is defined for a given Packer build execution.
+	// HCPConfigUnset mode is set when no HCP configuration has been found for the Packer execution.
 	HCPConfigUnset HCPConfigMode = iota
+	// HCPConfigEnabled mode is set when the HCP configuration is codified in the template.
 	HCPConfigEnabled
+	// HCPEnvEnabled mode is set when the HCP configuration is read from environment variables.
 	HCPEnvEnabled
 )