From c3ae34f581966a62a34dbbf8bc4351ef842ab591 Mon Sep 17 00:00:00 2001
From: teastep <teastep@fbd18981-670d-0410-9b5c-8dc0c1a9a2bb>
Date: Tue, 12 Jun 2007 13:40:25 +0000
Subject: [PATCH] Update release notes

git-svn-id: https://shorewall.svn.sourceforge.net/svnroot/shorewall/trunk@6524 fbd18981-670d-0410-9b5c-8dc0c1a9a2bb
---
 Shorewall-common/releasenotes.txt | 31 ++++++++++++++++++++++++-------
 1 file changed, 24 insertions(+), 7 deletions(-)

diff --git a/Shorewall-common/releasenotes.txt b/Shorewall-common/releasenotes.txt
index 8d65472ef..8e3d578c0 100644
--- a/Shorewall-common/releasenotes.txt
+++ b/Shorewall-common/releasenotes.txt
@@ -93,16 +93,33 @@ Other changes in Shorewall 4.0.0 Beta 5.
 
 	   compiler( $objectfile )
 
-	       The compiler function accepts 1 argument. If it corresponds to
-	       the <filename> run-line argument. If the argument is
-	       false, then a check is performed; otherwise, the
-	       configuration is compiled into the named file.
+	       The compiler function accepts 1 argument corresponding
+	       to the <filename> run-line argument. If the argument is
+	       false, then a syntax check of the configuration is
+	       performed;  otherwise, the configuration is compiled
+	       into the file named in the argument.
 
-	       Compilation errors cause the compiler to raise an exception via
-	       die.
+	       Compilation errors cause the compiler to raise an
+	       exception via die.
 
 	       Important: The 'compiler' function may only be called
-	       once in the block containing 'use Shorewall::Compiler'.
+	       once in the block containing 'use
+	       Shorewall::Compiler'. So you probably want to code this
+	       as:
+
+	       ...
+	       {
+	           use Shorewall::Compiler;
+
+		   eval {
+			configure( ... )
+			compiler( ... )
+		   }
+
+		   if ( $@ ) {
+		        <compilation failed>
+                   }
+              }
 
 Migration Considerations: