From b6917f386e5f6af570973d42e63baeb4a98d6261 Mon Sep 17 00:00:00 2001
From: Christian Breunig <christian@breunig.cc>
Date: Sun, 8 Oct 2023 10:27:27 +0200
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.

(cherry picked from commit a68c9238111c6caee78bb28f8054b8f0cfa0e374)
---
 interface-definitions/container.xml.in | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

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

diff --git a/interface-definitions/container.xml.in b/interface-definitions/container.xml.in
index ec22693c9..85baec2ba 100644
--- a/interface-definitions/container.xml.in
+++ b/interface-definitions/container.xml.in
@@ -147,7 +147,7 @@
           </leafNode>
           <leafNode name="memory">
             <properties>
-              <help>Memory (RAM) available to this container (default: 512)</help>
+              <help>Memory (RAM) available to this container</help>
               <valueHelp>
                 <format>u32:0</format>
                 <description>Unlimited</description>
@@ -165,7 +165,7 @@
           </leafNode>
           <leafNode name="shared-memory">
             <properties>
-              <help>Shared memory available to this container (default: 64)</help>
+              <help>Shared memory available to this container</help>
               <valueHelp>
                 <format>u32:0</format>
                 <description>Unlimited</description>
@@ -243,7 +243,7 @@
               </leafNode>
               <leafNode name="protocol">
                 <properties>
-                  <help>Transport protocol used for port mapping (default: tcp)</help>
+                  <help>Transport protocol used for port mapping</help>
                   <completionHelp>
                     <list>tcp udp</list>
                   </completionHelp>
@@ -265,7 +265,7 @@
           </tagNode>
           <leafNode name="restart">
             <properties>
-              <help>Restart options for container (default: on-failure)</help>
+              <help>Restart options for container</help>
               <completionHelp>
                 <list>no on-failure always</list>
               </completionHelp>
@@ -312,7 +312,7 @@
               </leafNode>
               <leafNode name="mode">
                 <properties>
-                  <help>Volume access mode ro/rw (default: rw)</help>
+                  <help>Volume access mode ro/rw</help>
                   <completionHelp>
                     <list>ro rw</list>
                   </completionHelp>
-- 
cgit v1.2.3