[pve-devel] [PATCH qemu-server] document hugepages option

[pve-devel] [PATCH qemu-server] document hugepages option

[Maximiliano Sandoval]

Given that there is no 0 enum, we remove the word "disabled" from the
docs. We also document that the unit is MiB.

Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
---
 src/PVE/QemuServer.pm | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/src/PVE/QemuServer.pm b/src/PVE/QemuServer.pm
index f263fedb..9d2bba71 100644
--- a/src/PVE/QemuServer.pm
+++ b/src/PVE/QemuServer.pm
@@ -442,7 +442,10 @@ EODESC
     hugepages => {
         optional => 1,
         type => 'string',
-        description => "Enable/disable hugepages memory.",
+        description =>
+            "Enables hugepages memory.\n\nSets the size of hugepages in MiBs. If the value "
+            . "is set to 'any' then 1 GiB hugepages will be used if possible, "
+            . "otherwise the size will fall back to 2 MiB.",
         enum => [qw(any 2 1024)],
     },
     keephugepages => {
-- 
2.47.2



_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel

Re: [pve-devel] [PATCH qemu-server] document hugepages option

[Daniel Kral]

On Thu Aug 28, 2025 at 2:49 PM CEST, Maximiliano Sandoval wrote:
> Given that there is no 0 enum, we remove the word "disabled" from the
> docs. We also document that the unit is MiB.
>
> Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
> ---
>  src/PVE/QemuServer.pm | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)
>
> diff --git a/src/PVE/QemuServer.pm b/src/PVE/QemuServer.pm
> index f263fedb..9d2bba71 100644
> --- a/src/PVE/QemuServer.pm
> +++ b/src/PVE/QemuServer.pm
> @@ -442,7 +442,10 @@ EODESC
>      hugepages => {
>          optional => 1,
>          type => 'string',
> -        description => "Enable/disable hugepages memory.",
> +        description =>
> +            "Enables hugepages memory.\n\nSets the size of hugepages in MiBs. If the value "
> +            . "is set to 'any' then 1 GiB hugepages will be used if possible, "
> +            . "otherwise the size will fall back to 2 MiB.",
>          enum => [qw(any 2 1024)],
>      },
>      keephugepages => {

As discussed off-list, it might be nice to have a 'off' option, as users
might not come to the conclusion that hugepages can only be disabled by
deleting the property from the config, but the change in description
definitely clarifies what the values mean here, so LGTM.


_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel