gen-pct-mountpoint-opts.pl: improve layout
authorDietmar Maurer <dietmar@proxmox.com>
Sat, 5 Nov 2016 16:21:04 +0000 (17:21 +0100)
committerDietmar Maurer <dietmar@proxmox.com>
Sat, 5 Nov 2016 16:21:04 +0000 (17:21 +0100)
gen-pct-mountpoint-opts.pl
pct-mountpoint-opts.adoc

index 6c2269c..151c18a 100755 (executable)
@@ -15,10 +15,14 @@ my $mp_prop = $prop->{mp0};
 
 my $typetext = PVE::JSONSchema::schema_get_type_text($rootfs_prop);
 
-print "`rootfs`: `$typetext`\n\n";
+print "`rootfs`: `$typetext` ::\n\n";
+
+print $rootfs_prop->{description} .
+    " See below for a detailed description of all options.\n\n";
 
 $typetext = PVE::JSONSchema::schema_get_type_text($mp_prop);
 
-print "`mp[n]`: `$typetext`\n\n";
+print "`mp[n]`: `$typetext` ::\n\n";
+print $mp_prop->{description} . "\n\n";
 
-print PVE::RESTHandler::dump_properties($mp_prop->{format});
+print PVE::RESTHandler::dump_properties($mp_prop->{format}, 'asciidoc', 'config-sub');
index feb85e1..e2a9f15 100644 (file)
@@ -1,40 +1,44 @@
-`rootfs`: `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]`
+`rootfs`: `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
 
-`mp[n]`: `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]`
+Use volume as container root. See below for a detailed description of all options.
 
-`acl`: `<boolean>` ::
+`mp[n]`: `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
+
+Use volume as container mount point.
+
+`acl`=`<boolean>` ;;
 
 Explicitly enable or disable ACL support.
 
-`backup`: `<boolean>` ::
+`backup`=`<boolean>` ;;
 
 Whether to include the mount point in backups (only used for volume mount points).
 
-`mp`: `<Path>` ::
+`mp`=`<Path>` ;;
 
 Path to the mount point as seen from inside the container.
 +
 NOTE: Must not contain any symlinks for security reasons.
 
-`quota`: `<boolean>` ::
+`quota`=`<boolean>` ;;
 
 Enable user quotas inside the container (not supported with zfs subvolumes)
 
-`ro`: `<boolean>` ::
+`ro`=`<boolean>` ;;
 
 Read-only mount point
 
-`shared`: `<boolean>` ('default =' `0`)::
+`shared`=`<boolean>` ('default =' `0`);;
 
 Mark this non-volume mount point as available on all nodes.
 +
 WARNING: This option does not share the mount point automatically, it assumes it is shared already!
 
-`size`: `<DiskSize>` ::
+`size`=`<DiskSize>` ;;
 
 Volume size (read only value).
 
-`volume`: `<volume>` ::
+`volume`=`<volume>` ;;
 
 Volume, device or directory to mount into the container.