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/interface/arp-cache-timeout.xml.i | 2 +-
 interface-definitions/include/interface/dhcp-options.xml.i      | 2 +-
 interface-definitions/include/interface/dhcpv6-options.xml.i    | 4 ++--
 3 files changed, 4 insertions(+), 4 deletions(-)

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

diff --git a/interface-definitions/include/interface/arp-cache-timeout.xml.i b/interface-definitions/include/interface/arp-cache-timeout.xml.i
index cb01d0525..06d7ffe96 100644
--- a/interface-definitions/include/interface/arp-cache-timeout.xml.i
+++ b/interface-definitions/include/interface/arp-cache-timeout.xml.i
@@ -4,7 +4,7 @@
     <help>ARP cache entry timeout in seconds</help>
     <valueHelp>
       <format>u32:1-86400</format>
-      <description>ARP cache entry timout in seconds (default 30)</description>
+      <description>ARP cache entry timout in seconds</description>
     </valueHelp>
     <constraint>
       <validator name="numeric" argument="--range 1-86400"/>
diff --git a/interface-definitions/include/interface/dhcp-options.xml.i b/interface-definitions/include/interface/dhcp-options.xml.i
index f62b06640..098d02919 100644
--- a/interface-definitions/include/interface/dhcp-options.xml.i
+++ b/interface-definitions/include/interface/dhcp-options.xml.i
@@ -30,7 +30,7 @@
         <help>Distance for the default route from DHCP server</help>
         <valueHelp>
           <format>u32:1-255</format>
-          <description>Distance for the default route from DHCP server (default: 210)</description>
+          <description>Distance for the default route from DHCP server</description>
         </valueHelp>
         <constraint>
           <validator name="numeric" argument="--range 1-255"/>
diff --git a/interface-definitions/include/interface/dhcpv6-options.xml.i b/interface-definitions/include/interface/dhcpv6-options.xml.i
index d1abf4a90..08e4f5e0a 100644
--- a/interface-definitions/include/interface/dhcpv6-options.xml.i
+++ b/interface-definitions/include/interface/dhcpv6-options.xml.i
@@ -57,10 +57,10 @@
           <children>
             <leafNode name="address">
               <properties>
-                <help>Local interface address assigned to interface</help>
+                <help>Local interface address assigned to interface (default: EUI-64)</help>
                 <valueHelp>
                   <format>&gt;0</format>
-                  <description>Used to form IPv6 interface address (default: EUI-64)</description>
+                  <description>Used to form IPv6 interface address</description>
                 </valueHelp>
                 <constraint>
                   <validator name="numeric" argument="--non-negative"/>
-- 
cgit v1.2.3