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/snmp.xml.in | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

(limited to 'interface-definitions/snmp.xml.in')

diff --git a/interface-definitions/snmp.xml.in b/interface-definitions/snmp.xml.in
index 67d3aef9a..b9e0f4cc5 100644
--- a/interface-definitions/snmp.xml.in
+++ b/interface-definitions/snmp.xml.in
@@ -26,7 +26,7 @@
                   </completionHelp>
                   <valueHelp>
                     <format>ro</format>
-                    <description>Read-Only (default)</description>
+                    <description>Read-Only</description>
                   </valueHelp>
                   <valueHelp>
                     <format>rw</format>
@@ -226,7 +226,7 @@
                       </valueHelp>
                       <valueHelp>
                         <format>auth</format>
-                        <description>Messages are authenticated but not encrypted (authNoPriv, default)</description>
+                        <description>Messages are authenticated but not encrypted (authNoPriv)</description>
                       </valueHelp>
                       <valueHelp>
                         <format>priv</format>
@@ -329,7 +329,7 @@
                         <list>inform trap</list>
                       </completionHelp>
                       <valueHelp>
-                        <format>inform (default)</format>
+                        <format>inform</format>
                         <description>Use INFORM</description>
                       </valueHelp>
                       <valueHelp>
-- 
cgit v1.2.3