From 57faafc8f8597f62d5edb5529349a565d7d2e865 Mon Sep 17 00:00:00 2001
From: Indrajit Raychaudhuri <irc@indrajit.com>
Date: Fri, 22 Dec 2023 17:22:20 -0600
Subject: firewall: T5834: Improve log message and simplify log-option include

`include/firewall/rule-log-options.xml.i` is now more aptly renamed to
`include/firewall/log-options.xml.i`.

(cherry picked from commit 53a48f499ae9bcc2f657136bb7779b38aad1c242)
---
 .../include/firewall/common-rule-bridge.xml.i      |  4 +-
 .../include/firewall/common-rule-inet.xml.i        |  2 +-
 .../include/firewall/common-rule-ipv4-raw.xml.i    |  2 +-
 .../include/firewall/log-options.xml.i             | 89 ++++++++++++++++++++++
 interface-definitions/include/firewall/log.xml.i   |  2 +-
 .../include/firewall/rule-log-options.xml.i        | 89 ----------------------
 6 files changed, 94 insertions(+), 94 deletions(-)
 create mode 100644 interface-definitions/include/firewall/log-options.xml.i
 delete mode 100644 interface-definitions/include/firewall/rule-log-options.xml.i

diff --git a/interface-definitions/include/firewall/common-rule-bridge.xml.i b/interface-definitions/include/firewall/common-rule-bridge.xml.i
index ebf95a111..dcdd970ac 100644
--- a/interface-definitions/include/firewall/common-rule-bridge.xml.i
+++ b/interface-definitions/include/firewall/common-rule-bridge.xml.i
@@ -19,7 +19,7 @@
   </properties>
 </leafNode>
 #include <include/firewall/log.xml.i>
-#include <include/firewall/rule-log-options.xml.i>
+#include <include/firewall/log-options.xml.i>
 <node name="source">
   <properties>
     <help>Source parameters</help>
@@ -31,4 +31,4 @@
 #include <include/firewall/inbound-interface.xml.i>
 #include <include/firewall/outbound-interface.xml.i>
 #include <include/firewall/match-vlan.xml.i>
-<!-- include end -->
\ No newline at end of file
+<!-- include end -->
diff --git a/interface-definitions/include/firewall/common-rule-inet.xml.i b/interface-definitions/include/firewall/common-rule-inet.xml.i
index 030adfe7c..3b5cb724d 100644
--- a/interface-definitions/include/firewall/common-rule-inet.xml.i
+++ b/interface-definitions/include/firewall/common-rule-inet.xml.i
@@ -78,7 +78,7 @@
   </children>
 </node>
 #include <include/firewall/log.xml.i>
-#include <include/firewall/rule-log-options.xml.i>
+#include <include/firewall/log-options.xml.i>
 <node name="connection-status">
   <properties>
     <help>Connection status</help>
diff --git a/interface-definitions/include/firewall/common-rule-ipv4-raw.xml.i b/interface-definitions/include/firewall/common-rule-ipv4-raw.xml.i
index a1071a09a..b253ee048 100644
--- a/interface-definitions/include/firewall/common-rule-ipv4-raw.xml.i
+++ b/interface-definitions/include/firewall/common-rule-ipv4-raw.xml.i
@@ -144,7 +144,7 @@
     </constraint>
   </properties>
 </leafNode>
-#include <include/firewall/rule-log-options.xml.i>
+#include <include/firewall/log-options.xml.i>
 <node name="connection-status">
   <properties>
     <help>Connection status</help>
diff --git a/interface-definitions/include/firewall/log-options.xml.i b/interface-definitions/include/firewall/log-options.xml.i
new file mode 100644
index 000000000..e8b0cdec3
--- /dev/null
+++ b/interface-definitions/include/firewall/log-options.xml.i
@@ -0,0 +1,89 @@
+<!-- include start from firewall/rule-log-options.xml.i -->
+<node name="log-options">
+   <properties>
+    <help>Log options</help>
+  </properties>
+  <children>
+    <leafNode name="group">
+      <properties>
+        <help>Set log group</help>
+        <valueHelp>
+          <format>u32:0-65535</format>
+          <description>Log group to send messages to</description>
+        </valueHelp>
+        <constraint>
+          <validator name="numeric" argument="--range 0-65535"/>
+        </constraint>
+      </properties>
+    </leafNode>
+    <leafNode name="snapshot-length">
+      <properties>
+        <help>Length of packet payload to include in netlink message</help>
+        <valueHelp>
+          <format>u32:0-9000</format>
+          <description>Length of packet payload to include in netlink message</description>
+        </valueHelp>
+        <constraint>
+          <validator name="numeric" argument="--range 0-9000"/>
+        </constraint>
+      </properties>
+    </leafNode>
+    <leafNode name="queue-threshold">
+      <properties>
+        <help>Number of packets to queue inside the kernel before sending them to userspace</help>
+        <valueHelp>
+          <format>u32:0-65535</format>
+          <description>Number of packets to queue inside the kernel before sending them to userspace</description>
+        </valueHelp>
+        <constraint>
+          <validator name="numeric" argument="--range 0-65535"/>
+        </constraint>
+      </properties>
+    </leafNode>
+    <leafNode name="level">
+      <properties>
+        <help>Set log-level</help>
+        <completionHelp>
+          <list>emerg alert crit err warn notice info debug</list>
+        </completionHelp>
+        <valueHelp>
+          <format>emerg</format>
+          <description>Emerg log level</description>
+        </valueHelp>
+        <valueHelp>
+          <format>alert</format>
+          <description>Alert log level</description>
+        </valueHelp>
+        <valueHelp>
+          <format>crit</format>
+          <description>Critical log level</description>
+        </valueHelp>
+        <valueHelp>
+          <format>err</format>
+          <description>Error log level</description>
+        </valueHelp>
+        <valueHelp>
+          <format>warn</format>
+          <description>Warning log level</description>
+        </valueHelp>
+        <valueHelp>
+          <format>notice</format>
+          <description>Notice log level</description>
+        </valueHelp>
+        <valueHelp>
+          <format>info</format>
+          <description>Info log level</description>
+        </valueHelp>
+        <valueHelp>
+          <format>debug</format>
+          <description>Debug log level</description>
+        </valueHelp>
+        <constraint>
+          <regex>(emerg|alert|crit|err|warn|notice|info|debug)</regex>
+        </constraint>
+        <constraintErrorMessage>level must be alert, crit, debug, emerg, err, info, notice or warn</constraintErrorMessage>
+      </properties>
+    </leafNode>
+  </children>
+</node>
+<!-- include end -->
\ No newline at end of file
diff --git a/interface-definitions/include/firewall/log.xml.i b/interface-definitions/include/firewall/log.xml.i
index 8f3fae1be..795ed77be 100644
--- a/interface-definitions/include/firewall/log.xml.i
+++ b/interface-definitions/include/firewall/log.xml.i
@@ -1,7 +1,7 @@
 <!-- include start from firewall/log.xml.i -->
 <leafNode name="log">
   <properties>
-    <help>Enable log</help>
+    <help>Log packets hitting this rule</help>
     <valueless/>
   </properties>
 </leafNode>
\ No newline at end of file
diff --git a/interface-definitions/include/firewall/rule-log-options.xml.i b/interface-definitions/include/firewall/rule-log-options.xml.i
deleted file mode 100644
index e8b0cdec3..000000000
--- a/interface-definitions/include/firewall/rule-log-options.xml.i
+++ /dev/null
@@ -1,89 +0,0 @@
-<!-- include start from firewall/rule-log-options.xml.i -->
-<node name="log-options">
-   <properties>
-    <help>Log options</help>
-  </properties>
-  <children>
-    <leafNode name="group">
-      <properties>
-        <help>Set log group</help>
-        <valueHelp>
-          <format>u32:0-65535</format>
-          <description>Log group to send messages to</description>
-        </valueHelp>
-        <constraint>
-          <validator name="numeric" argument="--range 0-65535"/>
-        </constraint>
-      </properties>
-    </leafNode>
-    <leafNode name="snapshot-length">
-      <properties>
-        <help>Length of packet payload to include in netlink message</help>
-        <valueHelp>
-          <format>u32:0-9000</format>
-          <description>Length of packet payload to include in netlink message</description>
-        </valueHelp>
-        <constraint>
-          <validator name="numeric" argument="--range 0-9000"/>
-        </constraint>
-      </properties>
-    </leafNode>
-    <leafNode name="queue-threshold">
-      <properties>
-        <help>Number of packets to queue inside the kernel before sending them to userspace</help>
-        <valueHelp>
-          <format>u32:0-65535</format>
-          <description>Number of packets to queue inside the kernel before sending them to userspace</description>
-        </valueHelp>
-        <constraint>
-          <validator name="numeric" argument="--range 0-65535"/>
-        </constraint>
-      </properties>
-    </leafNode>
-    <leafNode name="level">
-      <properties>
-        <help>Set log-level</help>
-        <completionHelp>
-          <list>emerg alert crit err warn notice info debug</list>
-        </completionHelp>
-        <valueHelp>
-          <format>emerg</format>
-          <description>Emerg log level</description>
-        </valueHelp>
-        <valueHelp>
-          <format>alert</format>
-          <description>Alert log level</description>
-        </valueHelp>
-        <valueHelp>
-          <format>crit</format>
-          <description>Critical log level</description>
-        </valueHelp>
-        <valueHelp>
-          <format>err</format>
-          <description>Error log level</description>
-        </valueHelp>
-        <valueHelp>
-          <format>warn</format>
-          <description>Warning log level</description>
-        </valueHelp>
-        <valueHelp>
-          <format>notice</format>
-          <description>Notice log level</description>
-        </valueHelp>
-        <valueHelp>
-          <format>info</format>
-          <description>Info log level</description>
-        </valueHelp>
-        <valueHelp>
-          <format>debug</format>
-          <description>Debug log level</description>
-        </valueHelp>
-        <constraint>
-          <regex>(emerg|alert|crit|err|warn|notice|info|debug)</regex>
-        </constraint>
-        <constraintErrorMessage>level must be alert, crit, debug, emerg, err, info, notice or warn</constraintErrorMessage>
-      </properties>
-    </leafNode>
-  </children>
-</node>
-<!-- include end -->
\ No newline at end of file
-- 
cgit v1.2.3