Skip to content

Commit 94d217c

Browse files
authored
docs: fix typos and grammer (#667)
Addressed spelling, grammar, and phrasing. Signed-off-by: Ryan Johnson <ryan.johnson@broadcom.com>
1 parent 09e41b6 commit 94d217c

20 files changed

Lines changed: 52 additions & 57 deletions

File tree

.web-docs/components/builder/vsphere-clone/README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -291,7 +291,7 @@ JSON Example:
291291

292292
<!-- Code generated from the comments of the ConfigParamsConfig struct in builder/vsphere/common/step_config_params.go; DO NOT EDIT MANUALLY -->
293293

294-
- `configuration_parameters` (map[string]string) - A map of key-value pairs to sent to the [`extraConfig`](https://dp-downloads.broadcom.com/api-content/apis/API_VWSA_001/8.0U3/html/ReferenceGuides/vim.vm.ConfigSpec.html#extraConfig).
294+
- `configuration_parameters` (map[string]string) - A map of key-value pairs to send to the [`extraConfig`](https://dp-downloads.broadcom.com/api-content/apis/API_VWSA_001/8.0U3/html/ReferenceGuides/vim.vm.ConfigSpec.html#extraConfig).
295295
in the vSphere API's `VirtualMachineConfigSpec`.
296296

297297
HCL Example:
@@ -315,7 +315,7 @@ JSON Example:
315315
```
316316

317317
~> **Note:** Configuration keys that would conflict with parameters that
318-
are explicitly configurable through other fields in the `ConfigSpec`` object
318+
are explicitly configurable through other fields in the `ConfigSpec` object
319319
are silently ignored. Refer to the [`VirtualMachineConfigSpec`](https://dp-downloads.broadcom.com/api-content/apis/API_VWSA_001/8.0U3/html/ReferenceGuides/vim.vm.ConfigSpec.html)
320320
in the vSphere API documentation.
321321

@@ -909,10 +909,10 @@ wget http://{{ .HTTPIP }}:{{ .HTTPPort }}/foo/bar/preseed.cfg
909909
- `floppy_dirs` ([]string) - A list of directories to copy files from.
910910

911911
- `floppy_content` (map[string]string) - Key/Values to add to the floppy disk. The keys represent the paths, and
912-
the values contents. It can be used alongside `floppy_files` or
912+
the value contents. It can be used alongside `floppy_files` or
913913
`floppy_dirs`, which is useful to add large files without loading them
914-
into memory. If any paths are specified by both, the contents in
915-
`floppy_content` will take precedence.
914+
into memory. If both specify a path, the contents in `floppy_content` will take
915+
precedence.
916916

917917
HCL Example:
918918

@@ -924,8 +924,8 @@ wget http://{{ .HTTPIP }}:{{ .HTTPPort }}/foo/bar/preseed.cfg
924924
```
925925

926926
- `floppy_label` (string) - The label to use for the floppy disk that is attached when the virtual
927-
machine is booted. This is most useful for cloud-init, Kickstart or other
928-
early initialization tools, which can benefit from labelled floppy disks.
927+
machine is booted. This is most useful for cloud-init, Kickstart, or other
928+
early initialization tools, which can benefit from labeled floppy disks.
929929
By default, the floppy label will be 'packer'.
930930

931931
<!-- End of code generated from the comments of the FloppyConfig struct in builder/vsphere/common/step_add_floppy.go; -->
@@ -937,8 +937,7 @@ wget http://{{ .HTTPIP }}:{{ .HTTPPort }}/foo/bar/preseed.cfg
937937

938938
<!-- Code generated from the comments of the ConnectConfig struct in builder/vsphere/common/step_connect.go; DO NOT EDIT MANUALLY -->
939939

940-
- `vcenter_server` (string) - The fully qualified domain name or IP address of the vCenter instance
941-
instance.
940+
- `vcenter_server` (string) - The fully qualified domain name or IP address of the vCenter instance.
942941

943942
- `username` (string) - The username to authenticate with the vCenter instance.
944943

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

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -107,8 +107,7 @@ wget http://{{ .HTTPIP }}:{{ .HTTPPort }}/foo/bar/preseed.cfg
107107

108108
<!-- Code generated from the comments of the ConnectConfig struct in builder/vsphere/common/step_connect.go; DO NOT EDIT MANUALLY -->
109109

110-
- `vcenter_server` (string) - The fully qualified domain name or IP address of the vCenter instance
111-
instance.
110+
- `vcenter_server` (string) - The fully qualified domain name or IP address of the vCenter instance.
112111

113112
- `username` (string) - The username to authenticate with the vCenter instance.
114113

@@ -182,7 +181,7 @@ wget http://{{ .HTTPIP }}:{{ .HTTPPort }}/foo/bar/preseed.cfg
182181

183182
- `convert_to_template` (bool) - Convert the virtual machine to a template after the build is complete.
184183
Defaults to `false`.
185-
If set to `true`, the virtual machine can not be imported into a content library.
184+
If set to `true`, the virtual machine cannot be imported into a content library.
186185

187186
- `export` (\*common.ExportConfig) - The configuration for exporting the virtual machine to an OVF.
188187
The virtual machine is not exported if [export configuration](#export-configuration) is not specified.
@@ -652,10 +651,10 @@ boot time.
652651
- `floppy_dirs` ([]string) - A list of directories to copy files from.
653652

654653
- `floppy_content` (map[string]string) - Key/Values to add to the floppy disk. The keys represent the paths, and
655-
the values contents. It can be used alongside `floppy_files` or
654+
the value contents. It can be used alongside `floppy_files` or
656655
`floppy_dirs`, which is useful to add large files without loading them
657-
into memory. If any paths are specified by both, the contents in
658-
`floppy_content` will take precedence.
656+
into memory. If both specify a path, the contents in `floppy_content` will take
657+
precedence.
659658

660659
HCL Example:
661660

@@ -667,8 +666,8 @@ boot time.
667666
```
668667

669668
- `floppy_label` (string) - The label to use for the floppy disk that is attached when the virtual
670-
machine is booted. This is most useful for cloud-init, Kickstart or other
671-
early initialization tools, which can benefit from labelled floppy disks.
669+
machine is booted. This is most useful for cloud-init, Kickstart, or other
670+
early initialization tools, which can benefit from labeled floppy disks.
672671
By default, the floppy label will be 'packer'.
673672

674673
<!-- End of code generated from the comments of the FloppyConfig struct in builder/vsphere/common/step_add_floppy.go; -->
@@ -1617,7 +1616,7 @@ JSON Example:
16171616

16181617
<!-- Code generated from the comments of the ConfigParamsConfig struct in builder/vsphere/common/step_config_params.go; DO NOT EDIT MANUALLY -->
16191618

1620-
- `configuration_parameters` (map[string]string) - A map of key-value pairs to sent to the [`extraConfig`](https://dp-downloads.broadcom.com/api-content/apis/API_VWSA_001/8.0U3/html/ReferenceGuides/vim.vm.ConfigSpec.html#extraConfig).
1619+
- `configuration_parameters` (map[string]string) - A map of key-value pairs to send to the [`extraConfig`](https://dp-downloads.broadcom.com/api-content/apis/API_VWSA_001/8.0U3/html/ReferenceGuides/vim.vm.ConfigSpec.html#extraConfig).
16211620
in the vSphere API's `VirtualMachineConfigSpec`.
16221621

16231622
HCL Example:
@@ -1641,7 +1640,7 @@ JSON Example:
16411640
```
16421641

16431642
~> **Note:** Configuration keys that would conflict with parameters that
1644-
are explicitly configurable through other fields in the `ConfigSpec`` object
1643+
are explicitly configurable through other fields in the `ConfigSpec` object
16451644
are silently ignored. Refer to the [`VirtualMachineConfigSpec`](https://dp-downloads.broadcom.com/api-content/apis/API_VWSA_001/8.0U3/html/ReferenceGuides/vim.vm.ConfigSpec.html)
16461645
in the vSphere API documentation.
16471646

.web-docs/components/data-source/virtualmachine/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,7 @@ virtual machine can be used in the vSphere Clone builder to select a template.
7676

7777
<!-- Code generated from the comments of the ConnectConfig struct in builder/vsphere/common/step_connect.go; DO NOT EDIT MANUALLY -->
7878

79-
- `vcenter_server` (string) - The fully qualified domain name or IP address of the vCenter instance
80-
instance.
79+
- `vcenter_server` (string) - The fully qualified domain name or IP address of the vCenter instance.
8180

8281
- `username` (string) - The username to authenticate with the vCenter instance.
8382

.web-docs/components/post-processor/vsphere/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ The following configuration options are available for the post-processor.
8585
same as the source virtual machine's.
8686

8787
This option is useful when deploying to vCenter instance or an ESX host whose
88-
version is different than the one used to create the artifact.
88+
version is different from the one used to create the artifact.
8989

9090
Refer to [KB 315655](https://knowledge.broadcom.com/external/article?articleNumber=315655)
9191
for more information on supported virtual hardware versions.

builder/vsphere/common/step_add_floppy.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ type FloppyConfig struct {
2828
// A list of directories to copy files from.
2929
FloppyDirectories []string `mapstructure:"floppy_dirs"`
3030
// Key/Values to add to the floppy disk. The keys represent the paths, and
31-
// the values contents. It can be used alongside `floppy_files` or
31+
// the value contents. It can be used alongside `floppy_files` or
3232
// `floppy_dirs`, which is useful to add large files without loading them
33-
// into memory. If any paths are specified by both, the contents in
34-
// `floppy_content` will take precedence.
33+
// into memory. If both specify a path, the contents in `floppy_content` will take
34+
// precedence.
3535
//
3636
// HCL Example:
3737
//
@@ -43,8 +43,8 @@ type FloppyConfig struct {
4343
// ```
4444
FloppyContent map[string]string `mapstructure:"floppy_content"`
4545
// The label to use for the floppy disk that is attached when the virtual
46-
// machine is booted. This is most useful for cloud-init, Kickstart or other
47-
// early initialization tools, which can benefit from labelled floppy disks.
46+
// machine is booted. This is most useful for cloud-init, Kickstart, or other
47+
// early initialization tools, which can benefit from labeled floppy disks.
4848
// By default, the floppy label will be 'packer'.
4949
FloppyLabel string `mapstructure:"floppy_label"`
5050
}

builder/vsphere/common/step_boot_command.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ func (s *StepBootCommand) Run(ctx context.Context, state multistep.StateBag) mul
5656
return multistep.ActionContinue
5757
}
5858

59-
// Wait the for the vm to boot.
59+
// Wait for the vm to boot.
6060
if int64(s.Config.BootWait) > 0 {
6161
ui.Sayf("Waiting %s for boot...", s.Config.BootWait.String())
6262
select {
@@ -115,7 +115,7 @@ func (s *StepBootCommand) Run(ctx context.Context, state multistep.StateBag) mul
115115
}
116116
}
117117

118-
// Check if IP address was determined.
118+
// Check if the IP address was determined.
119119
if ip == "" {
120120
err := fmt.Errorf("error determining IP address")
121121
state.Put("error", err)

builder/vsphere/common/step_config_params.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import (
2020
)
2121

2222
type ConfigParamsConfig struct {
23-
// A map of key-value pairs to sent to the [`extraConfig`](https://dp-downloads.broadcom.com/api-content/apis/API_VWSA_001/8.0U3/html/ReferenceGuides/vim.vm.ConfigSpec.html#extraConfig).
23+
// A map of key-value pairs to send to the [`extraConfig`](https://dp-downloads.broadcom.com/api-content/apis/API_VWSA_001/8.0U3/html/ReferenceGuides/vim.vm.ConfigSpec.html#extraConfig).
2424
// in the vSphere API's `VirtualMachineConfigSpec`.
2525
//
2626
// HCL Example:
@@ -44,7 +44,7 @@ type ConfigParamsConfig struct {
4444
// ```
4545
//
4646
// ~> **Note:** Configuration keys that would conflict with parameters that
47-
// are explicitly configurable through other fields in the `ConfigSpec`` object
47+
// are explicitly configurable through other fields in the `ConfigSpec` object
4848
// are silently ignored. Refer to the [`VirtualMachineConfigSpec`](https://dp-downloads.broadcom.com/api-content/apis/API_VWSA_001/8.0U3/html/ReferenceGuides/vim.vm.ConfigSpec.html)
4949
// in the vSphere API documentation.
5050
ConfigParams map[string]string `mapstructure:"configuration_parameters"`

builder/vsphere/common/step_connect.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,7 @@ import (
1919
)
2020

2121
type ConnectConfig struct {
22-
// The fully qualified domain name or IP address of the vCenter instance
23-
// instance.
22+
// The fully qualified domain name or IP address of the vCenter instance.
2423
VCenterServer string `mapstructure:"vcenter_server"`
2524
// The username to authenticate with the vCenter instance.
2625
Username string `mapstructure:"username"`

builder/vsphere/common/step_hardware.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import (
1616
"github.com/vmware/packer-plugin-vsphere/builder/vsphere/driver"
1717
)
1818

19-
// Dynamic DirectPath I/O is component of the Assignable Hardware framework in VMware vSphere.
19+
// Dynamic DirectPath I/O is the component of the Assignable Hardware framework in VMware vSphere.
2020
// Dynamic DirectPath I/O enables the Assignable Hardware intelligence for passthrough devices and
2121
// the hardware address of the PCIe device is no longer directly mapped to the virtual machine
2222
// configuration. Instead, the attributes, or capabilities, are exposed to the virtual machine.

builder/vsphere/driver/vm.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -825,7 +825,7 @@ func (vm *VirtualMachineDriver) PowerOn() error {
825825
return err
826826
}
827827

828-
// WaitForIP waits for the virtual machine to obtain an IP address.
828+
// WaitForIP waits for the virtual machine to get an IP address.
829829
func (vm *VirtualMachineDriver) WaitForIP(ctx context.Context, ipNet *net.IPNet) (string, error) {
830830
netIP, err := vm.vm.WaitForNetIP(ctx, false)
831831
if err != nil {
@@ -975,7 +975,7 @@ func (vm *VirtualMachineDriver) ImportOvfToContentLibrary(ovf vcenter.OVF) error
975975

976976
item, err := vm.driver.FindContentLibraryItem(l.library.ID, ovf.Spec.Name)
977977
if err == nil {
978-
// Update the content library item, if it exists.
978+
// Update the content library item if it exists.
979979
ovf.Target.LibraryItemID = item.ID
980980
if item.Description != nil && ovf.Spec.Description != *item.Description {
981981
err = vm.driver.UpdateContentLibraryItem(item, ovf.Spec.Name, ovf.Spec.Description)
@@ -1095,7 +1095,7 @@ func (vm *VirtualMachineDriver) GetDir() (string, error) {
10951095
}
10961096

10971097
// addNetwork adds a network to the virtual machine. Returns a list of devices
1098-
// with the network added or an error if the operation fails.
1098+
// with the network added or an error if the operation fails.
10991099
func addNetwork(d *VCenterDriver, devices object.VirtualDeviceList, config *CreateConfig) (object.VirtualDeviceList, error) {
11001100
for _, nic := range config.NICs {
11011101
network, err := findNetwork(nic.Network, config.Host, d)
@@ -1137,7 +1137,7 @@ func findNetwork(network string, host string, d *VCenterDriver) (object.NetworkR
11371137
return networks[0].network, nil
11381138
}
11391139

1140-
// If there are multiple networks then try to match the host.
1140+
// If there are multiple networks, then try to match the host.
11411141
if host != "" {
11421142
h, err := d.FindHost(host)
11431143
if err != nil {

0 commit comments

Comments
 (0)