-
Notifications
You must be signed in to change notification settings - Fork 106
Description
Overview of the Issue
In the docs, it says for disk_size that the value is "The size of the disk in MB":
It is in fact in MiB (1 048 576 bytes) not MB (1 000 000 bytes). It may seem like a minor detail, but these things are important. Trusting the documentation to be correct, I spent hours debugging why the disk size was incorrect for me. I do grant you that MB is not 100% wrong, just ambiguous, because of the legacy of the term. But since we can use a more correct term now, I think we should.
More occurrences
I have a hard time pin-pointing the exact line in this GitHub repo, but there are a handful of lines like this one:
"The size of the disk in MB" strings in this repo
| // The size of the disk in MB. |
packer-plugin-vsphere/docs-partials/builder/vsphere/common/DiskConfig-required.mdx
Line 3 in 4c8910c
| - `disk_size` (int64) - The size of the disk in MB. |
packer-plugin-vsphere/docs-partials/builder/vsphere/clone/CloneConfig-not-required.mdx
Line 5 in 4c8910c
| - `disk_size` (int64) - The size of the disk in MB. |
| - `disk_size` (int64) - The size of the disk in MB. |
| // The size of the disk in MB. |
| - `disk_size` (int64) - The size of the disk in MB. |
| - `disk_size` (int64) - The size of the disk in MB. |
I do not know if all of these are incorrect, or if some of them are actually in MB. That should be investigated before changing them.
Multiple-byte units
For more information about the binary and decimal unit prefixes, please see https://en.wikipedia.org/wiki/Byte#Multiple-byte_units
