From 1a859a97f840d0205670eb96ff4fbc0dbe263b7e Mon Sep 17 00:00:00 2001
From: Christian Poessinger <christian@poessinger.com>
Date: Fri, 2 Jul 2021 22:12:43 +0200
Subject: xml: provide building block for a generic description node

---
 interface-definitions/firewall.xml.in              | 18 +++++------
 .../include/firewall/common-rule.xml.i             |  2 +-
 .../include/firewall/description.xml.i             | 11 -------
 .../include/generic-description.xml.i              | 11 +++++++
 .../include/policy/description.xml.i               | 11 -------
 interface-definitions/policy.xml.in                | 36 +++++++++++-----------
 interface-definitions/vpn_ipsec.xml.in             |  9 ++----
 7 files changed, 41 insertions(+), 57 deletions(-)
 delete mode 100644 interface-definitions/include/firewall/description.xml.i
 create mode 100644 interface-definitions/include/generic-description.xml.i
 delete mode 100644 interface-definitions/include/policy/description.xml.i

diff --git a/interface-definitions/firewall.xml.in b/interface-definitions/firewall.xml.in
index 5528d6bc5..f07c619a8 100644
--- a/interface-definitions/firewall.xml.in
+++ b/interface-definitions/firewall.xml.in
@@ -91,7 +91,7 @@
                   <multi/>
                 </properties>
               </leafNode>
-              #include <include/firewall/description.xml.i>
+              #include <include/generic-description.xml.i>
             </children>
           </tagNode>
           <tagNode name="ipv6-address-group">
@@ -112,7 +112,7 @@
                   <multi/>
                 </properties>
               </leafNode>
-              #include <include/firewall/description.xml.i>
+              #include <include/generic-description.xml.i>
             </children>
           </tagNode>
           <tagNode name="ipv6-network-group">
@@ -120,7 +120,7 @@
               <help>Network-group member</help>
             </properties>
             <children>
-              #include <include/firewall/description.xml.i>
+              #include <include/generic-description.xml.i>
               <leafNode name="network">
                 <properties>
                   <help>Network-group member</help>
@@ -141,7 +141,7 @@
               <help>Firewall network-group</help>
             </properties>
             <children>
-              #include <include/firewall/description.xml.i>
+              #include <include/generic-description.xml.i>
               <leafNode name="network">
                 <properties>
                   <help>Network-group member</help>
@@ -162,7 +162,7 @@
               <help>Firewall port-group</help>
             </properties>
             <children>
-              #include <include/firewall/description.xml.i>
+              #include <include/generic-description.xml.i>
               <leafNode name="port">
                 <properties>
                   <help>Port-group member</help>
@@ -210,15 +210,15 @@
         </properties>
         <children>
           #include <include/firewall/name-default-action.xml.i>
-          #include <include/firewall/description.xml.i>
           #include <include/firewall/name-default-log.xml.i>
+          #include <include/generic-description.xml.i>
           <tagNode name="rule">
             <properties>
               <help>Rule number (1-9999)</help>
             </properties>
             <children>
               #include <include/firewall/action.xml.i>
-              #include <include/firewall/description.xml.i>
+              #include <include/generic-description.xml.i>
               <node name="destination">
                 <properties>
                   <help>Destination parameters</help>
@@ -578,15 +578,15 @@
         </properties>
         <children>
           #include <include/firewall/name-default-action.xml.i>
-          #include <include/firewall/description.xml.i>
           #include <include/firewall/name-default-log.xml.i>
+          #include <include/generic-description.xml.i>
           <tagNode name="rule">
             <properties>
               <help>Rule number (1-9999)</help>
             </properties>
             <children>
               #include <include/firewall/action.xml.i>
-              #include <include/firewall/description.xml.i>
+              #include <include/generic-description.xml.i>
               <node name="destination">
                 <properties>
                   <help>Destination parameters</help>
diff --git a/interface-definitions/include/firewall/common-rule.xml.i b/interface-definitions/include/firewall/common-rule.xml.i
index 466599e0a..1ee8da73d 100644
--- a/interface-definitions/include/firewall/common-rule.xml.i
+++ b/interface-definitions/include/firewall/common-rule.xml.i
@@ -1,6 +1,6 @@
 <!-- include start from firewall/common-rule.xml.i -->
 #include <include/firewall/action.xml.i>
-#include <include/firewall/description.xml.i>
+#include <include/generic-description.xml.i>
 <leafNode name="disable">
   <properties>
     <help>Option to disable firewall rule</help>
diff --git a/interface-definitions/include/firewall/description.xml.i b/interface-definitions/include/firewall/description.xml.i
deleted file mode 100644
index b6bae406b..000000000
--- a/interface-definitions/include/firewall/description.xml.i
+++ /dev/null
@@ -1,11 +0,0 @@
-<!-- include start from firewall/description.xml.i -->
-<leafNode name="description">
-  <properties>
-    <help>Description</help>
-    <valueHelp>
-      <format>txt</format>
-      <description>Description</description>
-    </valueHelp>
-  </properties>
-</leafNode>
-<!-- include end -->
diff --git a/interface-definitions/include/generic-description.xml.i b/interface-definitions/include/generic-description.xml.i
new file mode 100644
index 000000000..03fc564e6
--- /dev/null
+++ b/interface-definitions/include/generic-description.xml.i
@@ -0,0 +1,11 @@
+<!-- include start from generic-description.xml.i -->
+<leafNode name="description">
+  <properties>
+    <help>Description</help>
+    <valueHelp>
+      <format>txt</format>
+      <description>Description</description>
+    </valueHelp>
+  </properties>
+</leafNode>
+<!-- include end -->
diff --git a/interface-definitions/include/policy/description.xml.i b/interface-definitions/include/policy/description.xml.i
deleted file mode 100644
index e2ff35d02..000000000
--- a/interface-definitions/include/policy/description.xml.i
+++ /dev/null
@@ -1,11 +0,0 @@
-<!-- include start from policy/description.xml.i -->
-<leafNode name="description">
-  <properties>
-    <help>Description</help>
-    <valueHelp>
-      <format>txt</format>
-      <description>Description</description>
-    </valueHelp>
-  </properties>
-</leafNode>
-<!-- include end -->
diff --git a/interface-definitions/policy.xml.in b/interface-definitions/policy.xml.in
index 6a002cc20..5a3c58fa8 100644
--- a/interface-definitions/policy.xml.in
+++ b/interface-definitions/policy.xml.in
@@ -27,7 +27,7 @@
           </valueHelp>
         </properties>
         <children>
-          #include <include/policy/description.xml.i>
+          #include <include/generic-description.xml.i>
           <tagNode name="rule">
             <properties>
               <help>Rule for this access-list</help>
@@ -41,7 +41,7 @@
             </properties>
             <children>
               #include <include/policy/action.xml.i>
-              #include <include/policy/description.xml.i>
+              #include <include/generic-description.xml.i>
               <node name="destination">
                 <properties>
                   <help>Destination network or address</help>
@@ -87,7 +87,7 @@
           </valueHelp>
         </properties>
         <children>
-          #include <include/policy/description.xml.i>
+          #include <include/generic-description.xml.i>
           <tagNode name="rule">
             <properties>
               <help>Rule for this access-list6</help>
@@ -101,7 +101,7 @@
             </properties>
             <children>
               #include <include/policy/action.xml.i>
-              #include <include/policy/description.xml.i>
+              #include <include/generic-description.xml.i>
               <node name="source">
                 <properties>
                   <help>Source IPv6 network to match</help>
@@ -146,7 +146,7 @@
           </valueHelp>
         </properties>
         <children>
-          #include <include/policy/description.xml.i>
+          #include <include/generic-description.xml.i>
           <tagNode name="rule">
             <properties>
               <help>Rule for this as-path-list</help>
@@ -160,7 +160,7 @@
             </properties>
             <children>
               #include <include/policy/action.xml.i>
-              #include <include/policy/description.xml.i>
+              #include <include/generic-description.xml.i>
               <leafNode name="regex">
                 <properties>
                   <help>Regular expression to match against an AS path</help>
@@ -183,7 +183,7 @@
           </valueHelp>
         </properties>
         <children>
-          #include <include/policy/description.xml.i>
+          #include <include/generic-description.xml.i>
           <tagNode name="rule">
             <properties>
               <help>Rule for this BGP community list</help>
@@ -197,7 +197,7 @@
             </properties>
             <children>
               #include <include/policy/action.xml.i>
-              #include <include/policy/description.xml.i>
+              #include <include/generic-description.xml.i>
               <leafNode name="regex">
                 <properties>
                   <help>Regular expression to match against a community-list</help>
@@ -243,7 +243,7 @@
           </valueHelp>
         </properties>
         <children>
-          #include <include/policy/description.xml.i>
+          #include <include/generic-description.xml.i>
           <tagNode name="rule">
             <properties>
               <help>Rule for this BGP extended community list</help>
@@ -257,7 +257,7 @@
             </properties>
             <children>
               #include <include/policy/action.xml.i>
-              #include <include/policy/description.xml.i>
+              #include <include/generic-description.xml.i>
               <leafNode name="regex">
                 <properties>
                   <help>Regular expression to match against an extended community list</help>
@@ -288,7 +288,7 @@
           </valueHelp>
         </properties>
         <children>
-          #include <include/policy/description.xml.i>
+          #include <include/generic-description.xml.i>
           <tagNode name="rule">
             <properties>
               <help>Rule for this BGP extended community list</help>
@@ -302,7 +302,7 @@
             </properties>
             <children>
               #include <include/policy/action.xml.i>
-              #include <include/policy/description.xml.i>
+              #include <include/generic-description.xml.i>
               <leafNode name="regex">
                 <properties>
                   <help>Regular expression to match against a large community list</help>
@@ -329,7 +329,7 @@
           <constraintErrorMessage>Name of prefix-list can only contain alpha-numeric letters, hyphen and underscores</constraintErrorMessage>
         </properties>
         <children>
-          #include <include/policy/description.xml.i>
+          #include <include/generic-description.xml.i>
           <tagNode name="rule">
             <properties>
               <help>Rule for this prefix-list</help>
@@ -343,7 +343,7 @@
             </properties>
             <children>
               #include <include/policy/action.xml.i>
-              #include <include/policy/description.xml.i>
+              #include <include/generic-description.xml.i>
               <leafNode name="ge">
                 <properties>
                   <help>Prefix length to match a netmask greater than or equal to it</help>
@@ -397,7 +397,7 @@
           <constraintErrorMessage>Name of prefix-list6 can only contain alpha-numeric letters, hyphen and underscores</constraintErrorMessage>
         </properties>
         <children>
-          #include <include/policy/description.xml.i>
+          #include <include/generic-description.xml.i>
           <tagNode name="rule">
             <properties>
               <help>Rule for this prefix-list6</help>
@@ -411,7 +411,7 @@
             </properties>
             <children>
               #include <include/policy/action.xml.i>
-              #include <include/policy/description.xml.i>
+              #include <include/generic-description.xml.i>
               <leafNode name="ge">
                 <properties>
                   <help>Prefix length to match a netmask greater than or equal to it</help>
@@ -465,7 +465,7 @@
           <constraintErrorMessage>Name of route-map can only contain alpha-numeric letters, hyphen and underscores</constraintErrorMessage>
         </properties>
         <children>
-          #include <include/policy/description.xml.i>
+          #include <include/generic-description.xml.i>
           <tagNode name="rule">
             <properties>
               <help>Rule for this route-map</help>
@@ -500,7 +500,7 @@
                   </valueHelp>
                 </properties>
               </leafNode>
-              #include <include/policy/description.xml.i>
+              #include <include/generic-description.xml.i>
               <node name="match">
                 <properties>
                   <help>Route parameters to match</help>
diff --git a/interface-definitions/vpn_ipsec.xml.in b/interface-definitions/vpn_ipsec.xml.in
index 7b1b3a595..f51c2fc92 100644
--- a/interface-definitions/vpn_ipsec.xml.in
+++ b/interface-definitions/vpn_ipsec.xml.in
@@ -708,7 +708,7 @@
           </tagNode>
           <node name="site-to-site">
             <properties>
-              <help>Site to site VPN</help>
+              <help>Site-to-site VPN</help>
             </properties>
             <children>
               <tagNode name="peer">
@@ -837,12 +837,7 @@
                       </completionHelp>
                     </properties>
                   </leafNode>
-                  <leafNode name="description">
-                    <properties>
-                      <help>VPN peer description</help>
-                      <valueless/>
-                    </properties>
-                  </leafNode>
+                  #include <include/generic-description.xml.i>
                   <leafNode name="dhcp-interface">
                     <properties>
                       <help>DHCP interface to listen on</help>
-- 
cgit v1.2.3