[PATCH container] fix #7603: config: improve verbose description of mountpoint idmap

[PATCH container] fix #7603: config: improve verbose description of mountpoint idmap

[Filip Schauer]

Add more examples for range mapping and passthrough. Use \n\n between
paragraphs to improve readability in generated documentation.

Signed-off-by: Filip Schauer <f.schauer@proxmox.com>
---
 src/PVE/LXC/Config.pm | 20 ++++++++++++--------
 1 file changed, 12 insertions(+), 8 deletions(-)

diff --git a/src/PVE/LXC/Config.pm b/src/PVE/LXC/Config.pm
index c3fbd79..80942d3 100644
--- a/src/PVE/LXC/Config.pm
+++ b/src/PVE/LXC/Config.pm
@@ -377,14 +377,18 @@ my $rootfs_desc = {
         verbose_description =>
             "Customize UID/GID mappings that override the container's `lxc.idmap` for this mount "
             . "point. Accepts a semicolon-separated list of `type:container:disk:range-size` "
-            . "entries.\n"
-            . "`type` is `u` for UID or `g` for GID.\n"
-            . "`container` is the first ID as seen inside the container.\n"
-            . "`disk` is the first corresponding ID on the underlying filesystem.\n"
-            . "`range-size` is the number of consecutive IDs to map.\n"
-            . "Unmapped IDs fall back to the container's `lxc.idmap`.\n"
-            . "Example: `u:123:456:1` maps UID 123 in the container to UID 456 on the disk. "
-            . "Files owned by UID 456 on the disk will appear as UID 123 inside the container.",
+            . "entries.\n\n"
+            . "`type` is `u` for UID or `g` for GID.\n\n"
+            . "`container` is the first ID as seen inside the container.\n\n"
+            . "`disk` is the first corresponding ID on the underlying filesystem.\n\n"
+            . "`range-size` is the number of consecutive IDs to map.\n\n"
+            . "Unmapped IDs fall back to the container's `lxc.idmap`.\n\n"
+            . "Example 1: `u:123:456:1` maps UID 123 in the container to UID 456 on the disk. "
+            . "Files owned by UID 456 on the disk will appear as UID 123 inside the container.\n\n"
+            . "Example 2: `g:100:50:5` maps 5 consecutive GIDs, such that GIDs 100-104 in the "
+            . "container are mapped to GIDs 50-54 on the disk.\n\n"
+            . "Example 3: `passthrough` identity-maps all UIDs and GIDs, meaning IDs inside the "
+            . "container will match the IDs on the disk.",
         format_description =>
             'type:container:disk:range-size[;type:container:disk:range-size;...]',
         pattern =>
-- 
2.47.3

applied: [PATCH container] fix #7603: config: improve verbose description of mountpoint idmap

[Thomas Lamprecht]

On Tue, 19 May 2026 14:32:10 +0200, Filip Schauer wrote:
> Add more examples for range mapping and passthrough. Use \n\n between
> paragraphs to improve readability in generated documentation.

Applied, thanks!

[1/1] fix #7603: config: improve verbose description of mountpoint idmap
      commit: efca5f3011d2dac3d824da96c052fe6479e0463f