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/ospf/intervals.xml.i | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

(limited to 'interface-definitions/include/ospf/intervals.xml.i')

diff --git a/interface-definitions/include/ospf/intervals.xml.i b/interface-definitions/include/ospf/intervals.xml.i
index fad1a6305..9f6e5df69 100644
--- a/interface-definitions/include/ospf/intervals.xml.i
+++ b/interface-definitions/include/ospf/intervals.xml.i
@@ -1,7 +1,7 @@
 <!-- include start from ospf/intervals.xml.i -->
 <leafNode name="dead-interval">
   <properties>
-    <help>Interval after which a neighbor is declared dead (default: 40)</help>
+    <help>Interval after which a neighbor is declared dead</help>
     <valueHelp>
       <format>u32:1-65535</format>
       <description>Neighbor dead interval (seconds)</description>
@@ -14,7 +14,7 @@
 </leafNode>
 <leafNode name="hello-interval">
   <properties>
-    <help>Interval between hello packets (default: 10)</help>
+    <help>Interval between hello packets</help>
     <valueHelp>
       <format>u32:1-65535</format>
       <description>Hello interval (seconds)</description>
@@ -27,7 +27,7 @@
 </leafNode>
 <leafNode name="retransmit-interval">
   <properties>
-    <help>Interval between retransmitting lost link state advertisements (default: 5)</help>
+    <help>Interval between retransmitting lost link state advertisements</help>
     <valueHelp>
       <format>u32:1-65535</format>
       <description>Retransmit interval (seconds)</description>
@@ -40,7 +40,7 @@
 </leafNode>
 <leafNode name="transmit-delay">
   <properties>
-    <help>Link state transmit delay (default: 1)</help>
+    <help>Link state transmit delay</help>
     <valueHelp>
       <format>u32:1-65535</format>
       <description>Link state transmit delay (seconds)</description>
-- 
cgit v1.2.3