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

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

diff --git a/interface-definitions/containers.xml.in b/interface-definitions/containers.xml.in
index 07686b16e..9cd2b0902 100644
--- a/interface-definitions/containers.xml.in
+++ b/interface-definitions/containers.xml.in
@@ -111,7 +111,7 @@
           </leafNode>
           <leafNode name="memory">
             <properties>
-              <help>Constrain the memory available to a container (default: 512MB)</help>
+              <help>Constrain the memory available to a container</help>
               <valueHelp>
                 <format>u32:0</format>
                 <description>Unlimited</description>
@@ -212,7 +212,7 @@
               </valueHelp>
               <valueHelp>
                 <format>on-failure</format>
-                <description>Restart containers when they exit with a non-zero exit code, retrying indefinitely (default)</description>
+                <description>Restart containers when they exit with a non-zero exit code, retrying indefinitely</description>
               </valueHelp>
               <valueHelp>
                 <format>always</format>
@@ -283,7 +283,7 @@
       </tagNode>
       <leafNode name="registry">
         <properties>
-          <help>Add registry (default docker.io)</help>
+          <help>Add registry</help>
           <multi/>
         </properties>
         <defaultValue>docker.io</defaultValue>
-- 
cgit v1.2.3