extern/shorewall_code
1
0
Fork 1
mirror of https://gitlab.com/shorewall/code.git synced 2025-03-03 09:01:20 +01:00
Code Issues Packages Projects Releases Wiki Activity

Document push_/pop_/set_comment().

Browse Source 
Signed-off-by: Tom Eastep <teastep@shorewall.net>
This commit is contained in:
Tom Eastep 2013-09-26 07:09:23 -07:00
parent d7cbd1da21
commit 9f80ad8fb3
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/Actions.xml
View File

@ -738,6 +738,35 @@ bar:debug</programlisting>
</listitem>
</varlistentry>
<varlistentry>
<term>Shorewall::Config::push_comment()</term>
<listitem>
<para>Prior to Shorewall 4.5.21, this required:</para>
<programlisting>use Shorewall::Config (:DEFAULT :internal);</programlisting>
<para>Returns the current rule comment to the caller and clears the
comment. The returned comment may be restored by calling either
pop_comment() or set_comment().</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Shorewall::Config::pop_comment($comment) and
Shorewall::Config::set_comment($comment).</term>
<listitem>
<para>The set_comment() function was added in Shorewall 4.5.21.
Prior to that release, accessing pop_comment() required:</para>
<programlisting>use Shorewall::Config (:DEFAULT :internal);</programlisting>
<para>These functions are identical and set the current rule comment
to the contents of the passed simple variable.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Shorewall::Chains::add_rule(
<replaceable>$chainre</replaceable>f, <replaceable>$rule</replaceable>