From a68c9238111c6caee78bb28f8054b8f0cfa0e374 Mon Sep 17 00:00:00 2001
From: Christian Poessinger <christian@poessinger.com>
Date: Thu, 24 Feb 2022 22:47:12 +0100
Subject: 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.
---
 interface-definitions/include/bfd/common.xml.i | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

(limited to 'interface-definitions/include/bfd')

diff --git a/interface-definitions/include/bfd/common.xml.i b/interface-definitions/include/bfd/common.xml.i
index e52221441..126ab9b9a 100644
--- a/interface-definitions/include/bfd/common.xml.i
+++ b/interface-definitions/include/bfd/common.xml.i
@@ -15,7 +15,7 @@
         <help>Minimum interval of receiving control packets</help>
         <valueHelp>
           <format>u32:10-60000</format>
-          <description>Interval in milliseconds (default: 300)</description>
+          <description>Interval in milliseconds</description>
         </valueHelp>
         <constraint>
           <validator name="numeric" argument="--range 10-60000"/>
@@ -28,7 +28,7 @@
         <help>Minimum interval of transmitting control packets</help>
         <valueHelp>
           <format>u32:10-60000</format>
-          <description>Interval in milliseconds (default: 300)</description>
+          <description>Interval in milliseconds</description>
         </valueHelp>
         <constraint>
           <validator name="numeric" argument="--range 10-60000"/>
@@ -41,7 +41,7 @@
         <help>Multiplier to determine packet loss</help>
         <valueHelp>
           <format>u32:2-255</format>
-          <description>Remote transmission interval will be multiplied by this value (default: 3)</description>
+          <description>Remote transmission interval will be multiplied by this value</description>
         </valueHelp>
         <constraint>
           <validator name="numeric" argument="--range 2-255"/>
-- 
cgit v1.2.3