We use the changed method mainly in pve-docs to generate synopsis
from a schema. For now enums where always printed fully, which is not
a big problem for those with a relative small set of possibilities.
But we allow to use up to 256 mounpoints in pve-container now, and a
patch is pending to sync this number for (unused ?) disks in VMs,
so manpages which have an option referring to such a enum get pretty
long and not really nice, e.g. fsck command in man pct (ensure to
look in a recent version).
Initially I played with the idea to add a new type, 'range' which
would declare a basic key and a min (default to 0) to max range,
e.g. for the mountpoint case we'd had something alike:
mp => {
description => 'A Mountpoint...',
range => {
base => 'mp',
max => 255,
}
}
but as in the containercase we often have the set of ( mp0, mp1, ...,
mp255, rootfs) this is not really practicable I guess.
So I opted to summarize enum entries which consist of a word plus a
number, e.g., in the pct fsck man page case I output:
> pct fsck <vmid> [OPTIONS]
> ...
> --device <mp[0..255] | rootfs>
This happens only on build time for packages using pve-docs to
generate manpages, so even if it's a bit expensive that doesn't
matters much - and it should be pretty fast.
Signed-off-by: Thomas Lamprecht <[email protected]>
---
RFC for obvious reasons, it worked at the first try which worries me a
bit, so some subtle breakage may be there ^^
src/PVE/JSONSchema.pm | 28 +++++++++++++++++++++++++++-
1 file changed, 27 insertions(+), 1 deletion(-)
diff --git a/src/PVE/JSONSchema.pm b/src/PVE/JSONSchema.pm
index fb58ad3..92a5b04 100644
--- a/src/PVE/JSONSchema.pm
+++ b/src/PVE/JSONSchema.pm
@@ -1807,7 +1807,33 @@ sub schema_get_type_text {
} elsif ($phash->{format_description}) {
return "<$phash->{format_description}>";
} elsif ($phash->{enum}) {
- return "<" . join(' | ', sort @{$phash->{enum}}) . ">";
+ my $items = $phash->{enum};
+ my $reduced = {};
+ foreach my $v (@$items) {
+ if ($v =~ /([^\s\d]+)(\d+)/) {
+ my ($base, $id) = ($1, $2);
+ if (!exists($reduced->{$base})) {
+ $reduced->{$base}->{max} = $reduced->{$base}->{min} = $id;
+ } elsif ($id > $reduced->{$base}->{max}) {
+ $reduced->{$base}->{max} = $id;
+ } elsif ($id < $reduced->{$base}->{min}) {
+ $reduced->{$base}->{min} = $id;
+ }
+ } else {
+ $reduced->{$v} = undef;
+ }
+ }
+ $items = [];
+ foreach my $k (sort keys %$reduced) {
+ if (!defined($reduced->{$k})) {
+ push @$items, $k;
+ } else {
+ my ($min, $max) = $reduced->{$k}->@{qw(min max)};
+ push @$items, "${k}[$min..$max]";
+ }
+ }
+
+ return "<" . join(' | ', @$items) . ">";
} elsif ($phash->{pattern}) {
return $phash->{pattern};
} elsif ($type eq 'integer' || $type eq 'number') {
--
2.19.1
_______________________________________________
pve-devel mailing list
[email protected]
https://pve.proxmox.com/cgi-bin/mailman/listinfo/pve-devel
