From 83d4e362141e3c21a263b21da62c66f634953c37 Mon Sep 17 00:00:00 2001 From: teastep Date: Wed, 18 Apr 2007 23:55:25 +0000 Subject: [PATCH] More module comments git-svn-id: https://shorewall.svn.sourceforge.net/svnroot/shorewall/trunk@6012 fbd18981-670d-0410-9b5c-8dc0c1a9a2bb --- Shorewall-perl/Shorewall/Accounting.pm | 3 ++- Shorewall-perl/Shorewall/Actions.pm | 2 ++ Shorewall-perl/Shorewall/Hosts.pm | 2 ++ Shorewall-perl/Shorewall/Interfaces.pm | 4 ++++ Shorewall-perl/Shorewall/Macros.pm | 1 + Shorewall-perl/Shorewall/Nat.pm | 2 ++ Shorewall-perl/Shorewall/Policy.pm | 1 + Shorewall-perl/Shorewall/Proc.pm | 4 ++++ Shorewall-perl/Shorewall/Providers.pm | 2 ++ Shorewall-perl/Shorewall/Rules.pm | 1 + Shorewall-perl/Shorewall/Tc.pm | 1 + Shorewall-perl/Shorewall/Tunnels.pm | 1 + 12 files changed, 23 insertions(+), 1 deletion(-) diff --git a/Shorewall-perl/Shorewall/Accounting.pm b/Shorewall-perl/Shorewall/Accounting.pm index 2bc5bbbba..a26a2029d 100644 --- a/Shorewall-perl/Shorewall/Accounting.pm +++ b/Shorewall-perl/Shorewall/Accounting.pm @@ -20,8 +20,9 @@ # along with this program; if not, write to the Free Software # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA # +# This module contains the code that handles the /etc/shorewall/accounting +# file. # - package Shorewall::Accounting; require Exporter; use Shorewall::Common; diff --git a/Shorewall-perl/Shorewall/Actions.pm b/Shorewall-perl/Shorewall/Actions.pm index 80df90b92..f9525ac63 100644 --- a/Shorewall-perl/Shorewall/Actions.pm +++ b/Shorewall-perl/Shorewall/Actions.pm @@ -20,6 +20,8 @@ # along with this program; if not, write to the Free Software # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA # +# This module contains the code for dealing with actions (built-in, +# standard and user-defined). # package Shorewall::Actions; require Exporter; diff --git a/Shorewall-perl/Shorewall/Hosts.pm b/Shorewall-perl/Shorewall/Hosts.pm index 583bcb354..9b88fd07e 100644 --- a/Shorewall-perl/Shorewall/Hosts.pm +++ b/Shorewall-perl/Shorewall/Hosts.pm @@ -20,6 +20,8 @@ # along with this program; if not, write to the Free Software # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA # +# This module contains the code for dealing with the /etc/shorewall/hosts +# file. # package Shorewall::Hosts; require Exporter; diff --git a/Shorewall-perl/Shorewall/Interfaces.pm b/Shorewall-perl/Shorewall/Interfaces.pm index 9492d2797..aa83d14e5 100644 --- a/Shorewall-perl/Shorewall/Interfaces.pm +++ b/Shorewall-perl/Shorewall/Interfaces.pm @@ -20,7 +20,11 @@ # along with this program; if not, write to the Free Software # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA # +# This Module contains the code for processing the /etc/shorewall/interfaces +# file. It also exports 'add_group_to_zone()' which other modules call to +# alter zone membership. # + package Shorewall::Interfaces; require Exporter; use Shorewall::Common; diff --git a/Shorewall-perl/Shorewall/Macros.pm b/Shorewall-perl/Shorewall/Macros.pm index 9c390c18b..8ab5cf35f 100644 --- a/Shorewall-perl/Shorewall/Macros.pm +++ b/Shorewall-perl/Shorewall/Macros.pm @@ -20,6 +20,7 @@ # along with this program; if not, write to the Free Software # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA # +# This module exports some low-level module-oriented functions. # package Shorewall::Macros; require Exporter; diff --git a/Shorewall-perl/Shorewall/Nat.pm b/Shorewall-perl/Shorewall/Nat.pm index d29032d13..cee6a891c 100644 --- a/Shorewall-perl/Shorewall/Nat.pm +++ b/Shorewall-perl/Shorewall/Nat.pm @@ -20,6 +20,8 @@ # along with this program; if not, write to the Free Software # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA # +# This module contains code for dealing with the /etc/shorewall/masq, +# /etc/shorewall/nat and /etc/shorewall/netmap files. # package Shorewall::Nat; require Exporter; diff --git a/Shorewall-perl/Shorewall/Policy.pm b/Shorewall-perl/Shorewall/Policy.pm index 2f7f6c905..4a1201e4c 100644 --- a/Shorewall-perl/Shorewall/Policy.pm +++ b/Shorewall-perl/Shorewall/Policy.pm @@ -20,6 +20,7 @@ # along with this program; if not, write to the Free Software # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA # +# This module deals with the /etc/shorewall/policy file. # package Shorewall::Policy; require Exporter; diff --git a/Shorewall-perl/Shorewall/Proc.pm b/Shorewall-perl/Shorewall/Proc.pm index 04a1465ed..02e5be0f7 100644 --- a/Shorewall-perl/Shorewall/Proc.pm +++ b/Shorewall-perl/Shorewall/Proc.pm @@ -20,6 +20,10 @@ # along with this program; if not, write to the Free Software # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA # +# This module contains the code that deals with entries in /proc. +# +# Note: The /proc/sys/net/ipv4/conf/x/proxy_arp flag is handled +# in the Proxyarp module. # package Shorewall::Proc; require Exporter; diff --git a/Shorewall-perl/Shorewall/Providers.pm b/Shorewall-perl/Shorewall/Providers.pm index 34d34d066..0ed32adcb 100644 --- a/Shorewall-perl/Shorewall/Providers.pm +++ b/Shorewall-perl/Shorewall/Providers.pm @@ -20,6 +20,8 @@ # along with this program; if not, write to the Free Software # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA # +# This module deals with the /etc/shorewall/providers and +# /etc/shorewall/route_rules files. # package Shorewall::Providers; require Exporter; diff --git a/Shorewall-perl/Shorewall/Rules.pm b/Shorewall-perl/Shorewall/Rules.pm index 643a32773..8c5588812 100644 --- a/Shorewall-perl/Shorewall/Rules.pm +++ b/Shorewall-perl/Shorewall/Rules.pm @@ -20,6 +20,7 @@ # along with this program; if not, write to the Free Software # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA # +# This module contains the high-level code for dealing with rules. # package Shorewall::Rules; require Exporter; diff --git a/Shorewall-perl/Shorewall/Tc.pm b/Shorewall-perl/Shorewall/Tc.pm index ddd1f4f79..2a4334bfd 100644 --- a/Shorewall-perl/Shorewall/Tc.pm +++ b/Shorewall-perl/Shorewall/Tc.pm @@ -25,6 +25,7 @@ # along with this program; if not, write to the Free Software # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA # +# This module deals with Traffic Shaping and the tcrules file. # package Shorewall::Tc; require Exporter; diff --git a/Shorewall-perl/Shorewall/Tunnels.pm b/Shorewall-perl/Shorewall/Tunnels.pm index d7edbcc04..caba81a64 100644 --- a/Shorewall-perl/Shorewall/Tunnels.pm +++ b/Shorewall-perl/Shorewall/Tunnels.pm @@ -20,6 +20,7 @@ # along with this program; if not, write to the Free Software # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA # +# This module handles the /etc/shorewall/tunnels file. # package Shorewall::Tunnels; require Exporter;