From f8dd6ac321c6336cc5b612b6350e4f54e438d656 Mon Sep 17 00:00:00 2001 From: remi-espie Date: Tue, 21 Nov 2023 16:33:56 +0100 Subject: [PATCH] feat: rephrase `keep_registered` documentation --- .web-docs/components/builder/iso/README.md | 2 ++ .web-docs/components/builder/vmcx/README.md | 2 ++ builder/hyperv/common/config.go | 2 ++ .../builder/hyperv/common/CommonConfig-not-required.mdx | 2 ++ 4 files changed, 8 insertions(+) diff --git a/.web-docs/components/builder/iso/README.md b/.web-docs/components/builder/iso/README.md index 61c918fe..cce32d8e 100644 --- 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 index de465ee9..36f80bc5 100644 --- 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 index b7ab80fe..707e24dd 100644 --- 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 index 1e17038b..816be863 100644 --- 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.