diff options
author | Christian Poessinger <christian@poessinger.com> | 2022-02-24 22:47:12 +0100 |
---|---|---|
committer | Christian Poessinger <christian@poessinger.com> | 2022-02-24 22:47:12 +0100 |
commit | a68c9238111c6caee78bb28f8054b8f0cfa0e374 (patch) | |
tree | f3d2ce8e1e6dd4f8c7987685fd2c155c7813e266 /interface-definitions/service_monitoring_telegraf.xml.in | |
parent | 53517de05e9566c35218d1f07cacb1bff98a46d9 (diff) | |
download | vyos-1x-a68c9238111c6caee78bb28f8054b8f0cfa0e374.tar.gz vyos-1x-a68c9238111c6caee78bb28f8054b8f0cfa0e374.zip |
scripts: T4269: node.def generator should automatically add default values
Since introducing the XML <defaultValue> node it was common, but redundant,
practice to also add a help string indicating which value would be used as
default if the node is unset.
This makes no sense b/c it's duplicated code/value/characters and prone to
error. The node.def scripts should be extended to automatically render the
appropriate default value into the CLI help string.
For e.g. SSH the current PoC renders:
$ cat templates-cfg/service/ssh/port/node.def
multi:
type: txt
help: Port for SSH service (default: 22)
val_help: u32:1-65535; Numeric IP port
...
Not all subsystems are already migrated to get_config_dict() and make use of
the defaults() call - those subsystems need to be migrated, first before the new
default is added to the CLI help.
Diffstat (limited to 'interface-definitions/service_monitoring_telegraf.xml.in')
-rw-r--r-- | interface-definitions/service_monitoring_telegraf.xml.in | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/interface-definitions/service_monitoring_telegraf.xml.in b/interface-definitions/service_monitoring_telegraf.xml.in index 0db9052ff..f0a94d6a9 100644 --- a/interface-definitions/service_monitoring_telegraf.xml.in +++ b/interface-definitions/service_monitoring_telegraf.xml.in @@ -44,19 +44,19 @@ </node> <leafNode name="bucket"> <properties> - <help>Remote bucket, by default (main)</help> + <help>Remote bucket</help> </properties> <defaultValue>main</defaultValue> </leafNode> <leafNode name="source"> <properties> - <help>Source parameters for monitoring (default: all)</help> + <help>Source parameters for monitoring</help> <completionHelp> <list>all hardware-utilization logs network system telegraf</list> </completionHelp> <valueHelp> <format>all</format> - <description>All parameters (default)</description> + <description>All parameters</description> </valueHelp> <valueHelp> <format>hardware-utilization</format> |