Skip to content

Commit e677014

Browse files
authored
docs: update vmx_data_post (#401)
Updated comments and documentation to specify that `vmx_data_post` is applied after the virtual machine build is complete, rather than after the virtual machine is started. This improves clarity for advanced users configuring VMX options. Ran `make generate` to generate the documentation from the codebase. Signed-off-by: Ryan Johnson <ryan.johnson@broadcom.com>
1 parent 2000c3d commit e677014

File tree

4 files changed

+12
-12
lines changed

4 files changed

+12
-12
lines changed

.web-docs/components/builder/iso/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -722,16 +722,16 @@ wget http://{{ .HTTPIP }}:{{ .HTTPPort }}/foo/bar/preseed.cfg
722722
<!-- Code generated from the comments of the VMXConfig struct in builder/vmware/common/vmx_config.go; DO NOT EDIT MANUALLY -->
723723

724724
- `vmx_data` (map[string]string) - Key-value pairs that will be inserted into the virtual machine `.vmx`
725-
file **before** the virtual machine is started. This is useful for
725+
file before the virtual machine is started. This is useful for
726726
setting advanced properties that are not supported by the plugin.
727727

728728
~> **Note**: This option is intended for advanced users who understand
729729
the ramifications of making changes to the `.vmx` file. This option is
730730
not necessary for most users.
731731

732732
- `vmx_data_post` (map[string]string) - Key-value pairs that will be inserted into the virtual machine `.vmx`
733-
file **after** the virtual machine is started. This is useful for setting
734-
advanced properties that are not supported by the plugin.
733+
file after the virtual machine build is complete. This is useful for
734+
setting advanced properties that are not supported by the plugin.
735735

736736
~> **Note**: This option is intended for advanced users who understand
737737
the ramifications of making changes to the `.vmx` file. This option is

.web-docs/components/builder/vmx/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -498,16 +498,16 @@ wget http://{{ .HTTPIP }}:{{ .HTTPPort }}/foo/bar/preseed.cfg
498498
<!-- Code generated from the comments of the VMXConfig struct in builder/vmware/common/vmx_config.go; DO NOT EDIT MANUALLY -->
499499

500500
- `vmx_data` (map[string]string) - Key-value pairs that will be inserted into the virtual machine `.vmx`
501-
file **before** the virtual machine is started. This is useful for
501+
file before the virtual machine is started. This is useful for
502502
setting advanced properties that are not supported by the plugin.
503503

504504
~> **Note**: This option is intended for advanced users who understand
505505
the ramifications of making changes to the `.vmx` file. This option is
506506
not necessary for most users.
507507

508508
- `vmx_data_post` (map[string]string) - Key-value pairs that will be inserted into the virtual machine `.vmx`
509-
file **after** the virtual machine is started. This is useful for setting
510-
advanced properties that are not supported by the plugin.
509+
file after the virtual machine build is complete. This is useful for
510+
setting advanced properties that are not supported by the plugin.
511511

512512
~> **Note**: This option is intended for advanced users who understand
513513
the ramifications of making changes to the `.vmx` file. This option is

builder/vmware/common/vmx_config.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,16 @@ import (
1111

1212
type VMXConfig struct {
1313
// Key-value pairs that will be inserted into the virtual machine `.vmx`
14-
// file **before** the virtual machine is started. This is useful for
14+
// file before the virtual machine is started. This is useful for
1515
// setting advanced properties that are not supported by the plugin.
1616
//
1717
// ~> **Note**: This option is intended for advanced users who understand
1818
// the ramifications of making changes to the `.vmx` file. This option is
1919
// not necessary for most users.
2020
VMXData map[string]string `mapstructure:"vmx_data" required:"false"`
2121
// Key-value pairs that will be inserted into the virtual machine `.vmx`
22-
// file **after** the virtual machine is started. This is useful for setting
23-
// advanced properties that are not supported by the plugin.
22+
// file after the virtual machine build is complete. This is useful for
23+
// setting advanced properties that are not supported by the plugin.
2424
//
2525
// ~> **Note**: This option is intended for advanced users who understand
2626
// the ramifications of making changes to the `.vmx` file. This option is

docs-partials/builder/vmware/common/VMXConfig-not-required.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
<!-- Code generated from the comments of the VMXConfig struct in builder/vmware/common/vmx_config.go; DO NOT EDIT MANUALLY -->
22

33
- `vmx_data` (map[string]string) - Key-value pairs that will be inserted into the virtual machine `.vmx`
4-
file **before** the virtual machine is started. This is useful for
4+
file before the virtual machine is started. This is useful for
55
setting advanced properties that are not supported by the plugin.
66

77
~> **Note**: This option is intended for advanced users who understand
88
the ramifications of making changes to the `.vmx` file. This option is
99
not necessary for most users.
1010

1111
- `vmx_data_post` (map[string]string) - Key-value pairs that will be inserted into the virtual machine `.vmx`
12-
file **after** the virtual machine is started. This is useful for setting
13-
advanced properties that are not supported by the plugin.
12+
file after the virtual machine build is complete. This is useful for
13+
setting advanced properties that are not supported by the plugin.
1414

1515
~> **Note**: This option is intended for advanced users who understand
1616
the ramifications of making changes to the `.vmx` file. This option is

0 commit comments

Comments
 (0)