[pve-devel] [PATCH container] config: document that nameserver is a list

[pve-devel] [PATCH container] config: document that nameserver is a list

[Maximiliano Sandoval]

And for good measure, mention that it is comma-separated (even though it
can also be space-separated).

Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
---

This came up while working on [1] where it took me some time to figure out the
format.

The rendered docs reads at the moment:

>  nameserver: <string>
>
>    Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.

which does not indicate this might be a list nor how it is separated.


[1] https://lore.proxmox.com/all/20251218150126.832313-1-m.sandoval@proxmox.com/

 src/PVE/LXC/Config.pm | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/PVE/LXC/Config.pm b/src/PVE/LXC/Config.pm
index 6be38a2..7cb4e5c 100644
--- a/src/PVE/LXC/Config.pm
+++ b/src/PVE/LXC/Config.pm
@@ -606,7 +606,7 @@ my $confdesc = {
         type => 'string',
         format => 'lxc-ip-with-ll-iface-list',
         description =>
-            "Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.",
+            "Comma-separated list of IP addresses. Sets the addresses of the DNS servers of the container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.",
     },
     timezone => {
         optional => 1,
-- 
2.47.3



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

Re: [pve-devel] [PATCH container] config: document that nameserver is a list

[Fabian Grünbichler]

On December 18, 2025 4:19 pm, Maximiliano Sandoval wrote:
> And for good measure, mention that it is comma-separated (even though it
> can also be space-separated).
> 
> Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
> ---
> 
> This came up while working on [1] where it took me some time to figure out the
> format.
> 
> The rendered docs reads at the moment:
> 
>>  nameserver: <string>
>>
>>    Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
> 
> which does not indicate this might be a list nor how it is separated.

wouldn't it make more sense to make the doc generation include that
information automatically? a format name with -list at the end always
means that it is a \0 or ,;\s separated list of values of the "child"
format.. so instead of <string>, this could print

<lxc-ip-with-ll-iface>[, <lxc-ip-with-ll-iface>[, ..]]

for example, with all the required information already available in the
schema..

> 
> 
> [1] https://lore.proxmox.com/all/20251218150126.832313-1-m.sandoval@proxmox.com/
> 
>  src/PVE/LXC/Config.pm | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/src/PVE/LXC/Config.pm b/src/PVE/LXC/Config.pm
> index 6be38a2..7cb4e5c 100644
> --- a/src/PVE/LXC/Config.pm
> +++ b/src/PVE/LXC/Config.pm
> @@ -606,7 +606,7 @@ my $confdesc = {
>          type => 'string',
>          format => 'lxc-ip-with-ll-iface-list',
>          description =>
> -            "Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.",
> +            "Comma-separated list of IP addresses. Sets the addresses of the DNS servers of the container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.",
>      },
>      timezone => {
>          optional => 1,
> -- 
> 2.47.3
> 
> 
> 
> _______________________________________________
> pve-devel mailing list
> pve-devel@lists.proxmox.com
> https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel
> 
> 
> 


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