release doc update; add comments to prog.*

git-svn-id: https://shorewall.svn.sourceforge.net/svnroot/shorewall/trunk@9574 fbd18981-670d-0410-9b5c-8dc0c1a9a2bb

Shorewall/changelog.txt

@@ -1,3 +1,9 @@
+Changes in Shorewall 4.3.7
+
+1)  Fix forward treatment of interface options.
+
+2)  Replace $VARDIR/.restore with $VARDIR/firewall
+
 Changes in Shorewall 4.3.6
 
 1)  Add SAME tcrules target.

Shorewall/prog.footer

@@ -1,3 +1,6 @@
+###############################################################################
+# Code imported from /usr/share/shorewall/prog.footer
+###############################################################################
 #
 # Give Usage Information
 #

Shorewall/prog.footer6

@@ -1,3 +1,6 @@
+###############################################################################
+# Code imported from /usr/share/shorewall/prog.footer6
+###############################################################################
 #
 # Give Usage Information
 #

Shorewall/prog.functions

@@ -1,3 +1,6 @@
+####################################################################################
+# Functions imported from /usr/share/shorewall/prog.functions
+####################################################################################
 #
 # Clear Proxy Arp
 #
@@ -155,6 +158,9 @@ run_tc() {
     fi
 }
 
+#
+# Restore the rules generated by 'drop','reject','logdrop', etc.
+#
 restore_dynamic_rules() {
     if [ -f ${VARDIR}/save ]; then
 	progress_message2 "Setting up dynamic rules..."
@@ -271,3 +277,6 @@ debug_restore_input() {
 	esac
     done
 }
+####################################################################################
+# End of f unctions imported from /usr/share/shorewall/prog.functions
+####################################################################################

Shorewall/prog.functions6

@@ -1,3 +1,6 @@
+####################################################################################
+# Functions imported from /usr/share/shorewall/prog.functions6
+####################################################################################
 #
 # Remove all Shorewall-added rules
 #
@@ -131,6 +134,9 @@ run_tc() {
     fi
 }
 
+#
+# Restore the rules generated by 'drop','reject','logdrop', etc.
+#
 restore_dynamic_rules() {
     if [ -f ${VARDIR}/save ]; then
 	progress_message2 "Setting up dynamic rules..."
@@ -232,3 +238,6 @@ debug_restore_input() {
 	esac
     done
 }
+####################################################################################
+# End of f unctions imported from /usr/share/shorewall/prog.functions
+####################################################################################

Shorewall/prog.header

@@ -20,7 +20,7 @@
 #	   				  generated this program
 #
 ################################################################################
-# Functions imported from /usr/share/shorewall/lib.base
+# Functions imported from /usr/share/shorewall/prog.header
 ################################################################################
 #
 # Message to stderr
@@ -647,6 +647,9 @@ get_routed_networks() # $1 = interface name, $2-n = Fatal error message
         done
 }
 
+#
+# Get the broadcast addresses associated with an interface
+#
 get_interface_bcasts() # $1 = interface
 {
     local addresses
@@ -796,6 +799,9 @@ add_ip_aliases() # $* = List of addresses
     done
 }
 
+#
+# Detect the gateway through a PPP or DHCP-configured interface
+#
 detect_dynamic_gateway() { # $1 = interface
     local interface
     interface=$1
@@ -817,6 +823,9 @@ detect_dynamic_gateway() { # $1 = interface
     [ -n "$gateway" ] && echo $gateway
 }
 
+#
+# Detect the gateway through an interface
+#
 detect_gateway() # $1 = interface
 {
     local interface
@@ -872,6 +881,10 @@ truncate() # $1 = length
     cut -b -${1}
 }
 
+#
+# Clear the current traffic shaping configuration
+#
+
 delete_tc1()
 {
     clear_one_tc() {
@@ -953,6 +966,9 @@ undo_routing() {
 
 }
 
+#
+# Restore the default route that was in place before the initial 'shorewall start'
+#
 restore_default_route() {
     if [ -z "$NOROUTES" -a -f ${VARDIR}/default_route ]; then
 	local default_route
@@ -1052,5 +1068,5 @@ conditionally_flush_conntrack() {
 }
 
 ################################################################################
-# End of functions imported from /usr/share/shorewall/lib.base
+# End of functions in /usr/share/shorewall/prog.header
 ################################################################################

Shorewall/prog.header6

@@ -20,7 +20,7 @@
 #	   				  generated this program
 #
 ################################################################################
-# Functions imported from /usr/share/shorewall/lib.base
+# Functions imported from /usr/share/shorewall/prog.header
 ################################################################################
 #
 # Message to stderr
@@ -522,6 +522,9 @@ get_routed_networks() # $1 = interface name, $2-n = Fatal error message
         done
 }
 
+#
+# Normalize an IPv6 Address by compressing out consecutive zero elements
+#
 normalize_address() # $1 = valid IPv6 Address
 {
     local address
@@ -743,6 +746,9 @@ INCLUDE() {
     . $(find_file $(expand $@))
 }
 
+#
+# Detect the gateway through an interface
+#
 detect_gateway() # $1 = interface
 {
     local interface
@@ -765,11 +771,20 @@ detect_gateway() # $1 = interface
     [ -n "$gateway" ] && echo $gateway
 }
 
+# Function to truncate a string -- It uses 'cut -b -<n>'
+# rather than ${v:first:last} because light-weight shells like ash and
+# dash do not support that form of expansion.
+#
+
 truncate() # $1 = length
 {
     cut -b -${1}
 }
 
+#
+# Clear the current traffic shaping configuration
+#
+
 delete_tc1()
 {
     clear_one_tc() {
@@ -851,6 +866,9 @@ undo_routing() {
 
 }
 
+#
+# Restore the default route that was in place before the initial 'shorewall start'
+#
 restore_default_route() {
     if [ -z "$NOROUTES" -a -f ${VARDIR}/default_route ]; then
 	local default_route
@@ -950,5 +968,5 @@ conditionally_flush_conntrack() {
 }
 
 ################################################################################
-# End of functions imported from /usr/share/shorewall/lib.base
+# End of functions imported from /usr/share/shorewall/prog.header
 ################################################################################

Shorewall/releasenotes.txt

@@ -57,7 +57,12 @@ None.
                 N E W   F E A T U R E S   I N   4 . 3 . 6
 ----------------------------------------------------------------------------
 
-None.
+1)  The file /var/lib/shorewall/.restore has been renamed to
+    /var/lib/shorewall/firewall. A similar change has been made in
+    Shorewall6.
+
+    When a successful start or restart is completed, the script that
+    executed the command copies itself to to /var/lib/shorewall[6/firewall.
 
 ----------------------------------------------------------------------------
                  N E W   F E A T U R E S   IN   4 . 3