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/auto-cost.xml.i     |  2 +-
 .../include/ospf/interface-common.xml.i                |  2 +-
 interface-definitions/include/ospf/intervals.xml.i     |  8 ++++----
 interface-definitions/include/ospf/metric-type.xml.i   |  2 +-
 .../include/ospf/protocol-common-config.xml.i          | 18 +++++++++---------
 5 files changed, 16 insertions(+), 16 deletions(-)

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

diff --git a/interface-definitions/include/ospf/auto-cost.xml.i b/interface-definitions/include/ospf/auto-cost.xml.i
index 3e6cc8232..da6483a00 100644
--- a/interface-definitions/include/ospf/auto-cost.xml.i
+++ b/interface-definitions/include/ospf/auto-cost.xml.i
@@ -6,7 +6,7 @@
   <children>
     <leafNode name="reference-bandwidth">
       <properties>
-        <help>Reference bandwidth method to assign cost (default: 100)</help>
+        <help>Reference bandwidth method to assign cost</help>
         <valueHelp>
           <format>u32:1-4294967</format>
           <description>Reference bandwidth cost in Mbits/sec</description>
diff --git a/interface-definitions/include/ospf/interface-common.xml.i b/interface-definitions/include/ospf/interface-common.xml.i
index 738651594..9c8b94f0b 100644
--- a/interface-definitions/include/ospf/interface-common.xml.i
+++ b/interface-definitions/include/ospf/interface-common.xml.i
@@ -20,7 +20,7 @@
 </leafNode>
 <leafNode name="priority">
   <properties>
-    <help>Router priority (default: 1)</help>
+    <help>Router priority</help>
     <valueHelp>
       <format>u32:0-255</format>
       <description>OSPF router priority cost</description>
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>
diff --git a/interface-definitions/include/ospf/metric-type.xml.i b/interface-definitions/include/ospf/metric-type.xml.i
index ef9fd8ac0..de55c7645 100644
--- a/interface-definitions/include/ospf/metric-type.xml.i
+++ b/interface-definitions/include/ospf/metric-type.xml.i
@@ -1,7 +1,7 @@
 <!-- include start from ospf/metric-type.xml.i -->
 <leafNode name="metric-type">
   <properties>
-    <help>OSPF metric type for default routes (default: 2)</help>
+    <help>OSPF metric type for default routes</help>
     <valueHelp>
       <format>u32:1-2</format>
       <description>Set OSPF External Type 1/2 metrics</description>
diff --git a/interface-definitions/include/ospf/protocol-common-config.xml.i b/interface-definitions/include/ospf/protocol-common-config.xml.i
index e783f4bec..088bee2de 100644
--- a/interface-definitions/include/ospf/protocol-common-config.xml.i
+++ b/interface-definitions/include/ospf/protocol-common-config.xml.i
@@ -106,7 +106,7 @@
             </leafNode>
             <leafNode name="translate">
               <properties>
-                <help>Configure NSSA-ABR (default: candidate)</help>
+                <help>Configure NSSA-ABR</help>
                 <completionHelp>
                   <list>always candidate never</list>
                 </completionHelp>
@@ -116,7 +116,7 @@
                 </valueHelp>
                 <valueHelp>
                   <format>candidate</format>
-                  <description>Translate for election (default)</description>
+                  <description>Translate for election</description>
                 </valueHelp>
                 <valueHelp>
                   <format>never</format>
@@ -502,7 +502,7 @@
   <children>
     <leafNode name="poll-interval">
       <properties>
-        <help>Dead neighbor polling interval (default: 60)</help>
+        <help>Dead neighbor polling interval</help>
         <valueHelp>
           <format>u32:1-65535</format>
           <description>Seconds between dead neighbor polling interval</description>
@@ -515,7 +515,7 @@
     </leafNode>
     <leafNode name="priority">
       <properties>
-        <help>Neighbor priority in seconds (default: 0)</help>
+        <help>Neighbor priority in seconds</help>
         <valueHelp>
           <format>u32:0-255</format>
           <description>Neighbor priority</description>
@@ -535,13 +535,13 @@
   <children>
     <leafNode name="abr-type">
       <properties>
-        <help>OSPF ABR type (default: cisco)</help>
+        <help>OSPF ABR type</help>
         <completionHelp>
           <list>cisco ibm shortcut standard</list>
         </completionHelp>
         <valueHelp>
           <format>cisco</format>
-          <description>Cisco ABR type (default)</description>
+          <description>Cisco ABR type</description>
         </valueHelp>
         <valueHelp>
           <format>ibm</format>
@@ -712,7 +712,7 @@
           <children>
             <leafNode name="delay">
               <properties>
-                <help>Delay from the first change received to SPF calculation (default: 200)</help>
+                <help>Delay from the first change received to SPF calculation</help>
                 <valueHelp>
                   <format>u32:0-600000</format>
                   <description>Delay in milliseconds</description>
@@ -725,7 +725,7 @@
             </leafNode>
             <leafNode name="initial-holdtime">
               <properties>
-                <help>Initial hold time between consecutive SPF calculations (default: 1000)</help>
+                <help>Initial hold time between consecutive SPF calculations</help>
                 <valueHelp>
                   <format>u32:0-600000</format>
                   <description>Initial hold time in milliseconds</description>
@@ -738,7 +738,7 @@
             </leafNode>
             <leafNode name="max-holdtime">
               <properties>
-                <help>Maximum hold time (default: 10000)</help>
+                <help>Maximum hold time</help>
                 <valueHelp>
                   <format>u32:0-600000</format>
                   <description>Max hold time in milliseconds</description>
-- 
cgit v1.2.3