From 65acc7afe53e7b91e473262e631a13cf86432e05 Mon Sep 17 00:00:00 2001
From: teastep <teastep@fbd18981-670d-0410-9b5c-8dc0c1a9a2bb>
Date: Thu, 27 Mar 2008 21:00:53 +0000
Subject: [PATCH] Document how to place comments in the 'actions' file

git-svn-id: https://shorewall.svn.sourceforge.net/svnroot/shorewall/trunk@8369 fbd18981-670d-0410-9b5c-8dc0c1a9a2bb
---
 docs/Actions.xml | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/docs/Actions.xml b/docs/Actions.xml
index 7a8796c80..f2de12748 100644
--- a/docs/Actions.xml
+++ b/docs/Actions.xml
@@ -554,9 +554,14 @@ add_rule $chainref, '-j ACCEPT';
 
     <para><filename>/etc/shorewall/actions</filename>:</para>
 
-    <para><programlisting>     LogAndAccept</programlisting><phrase><filename>/etc/shorewall/action.LogAndAccept</filename></phrase><programlisting>     LOG:info
+    <para><programlisting>     #ACTION             COMMENT (place '# ' below the 'C' in comment followed by
+     #                   v        a comment describing the action)
+     LogAndAccept        # LOG and ACCEPT a connection</programlisting><phrase><filename>/etc/shorewall/action.LogAndAccept</filename></phrase><programlisting>     LOG:info
      ACCEPT</programlisting></para>
 
+    <para>Placing a comment on the line causes the comment to appear in the
+    output of the <command>shorewall show actions</command> command.</para>
+
     <para>To use your action, in <filename>/etc/shorewall/rules</filename> you
     might do something like:</para>