feat: rephrase keep_registered documentation

hashicorp · Nov 21, 2023 · f8dd6ac · f8dd6ac
1 parent a81cbbd
commit f8dd6ac
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 0 deletions.
diff --git a/.web-docs/components/builder/iso/README.md b/.web-docs/components/builder/iso/README.md
@@ -318,6 +318,8 @@ created, must be empty prior to running the builder. By default this is
 
 - `keep_registered` (bool) - If "true", Packer will not delete the VM from
   The Hyper-V manager.
+  The resulting VM will be housed in a randomly generated folder under %TEMP% by default.
+  You can set the `temp_path` variable to change the location of the folder.
 
 - `skip_compaction` (bool) - If true skip compacting the hard disk for
   the virtual machine when exporting. This defaults to false.

diff --git a/.web-docs/components/builder/vmcx/README.md b/.web-docs/components/builder/vmcx/README.md
@@ -345,6 +345,8 @@ In HCL2:
 
 - `keep_registered` (bool) - If "true", Packer will not delete the VM from
   The Hyper-V manager.
+  The resulting VM will be housed in a randomly generated folder under %TEMP% by default.
+  You can set the `temp_path` variable to change the location of the folder.
 
 - `skip_compaction` (bool) - If true skip compacting the hard disk for
   the virtual machine when exporting. This defaults to false.

diff --git a/builder/hyperv/common/config.go b/builder/hyperv/common/config.go
@@ -139,6 +139,8 @@ type CommonConfig struct {
 	Version string `mapstructure:"configuration_version" required:"false"`
 	// If "true", Packer will not delete the VM from
 	// The Hyper-V manager.
+	// The resulting VM will be housed in a randomly generated folder under %TEMP% by default.
+	// You can set the `temp_path` variable to change the location of the folder.
 	KeepRegistered bool `mapstructure:"keep_registered" required:"false"`
 	// If true skip compacting the hard disk for
 	// the virtual machine when exporting. This defaults to false.

diff --git a/docs-partials/builder/hyperv/common/CommonConfig-not-required.mdx b/docs-partials/builder/hyperv/common/CommonConfig-not-required.mdx
@@ -97,6 +97,8 @@
 
 - `keep_registered` (bool) - If "true", Packer will not delete the VM from
   The Hyper-V manager.
+  The resulting VM will be housed in a randomly generated folder under %TEMP% by default.
+  You can set the `temp_path` variable to change the location of the folder.
 
 - `skip_compaction` (bool) - If true skip compacting the hard disk for
   the virtual machine when exporting. This defaults to false.