Documentation -- internal and external

git-svn-id: https://shorewall.svn.sourceforge.net/svnroot/shorewall/trunk@6890 fbd18981-670d-0410-9b5c-8dc0c1a9a2bb
This commit is contained in:
teastep 2007-07-17 14:11:20 +00:00
parent a05226db9f
commit ac61fccfcf
2 changed files with 32 additions and 9 deletions

View File

@ -40,7 +40,8 @@ Problems corrected in 4.0.0 Final.
Other changes in Shorewall 4.0.0 Final. Other changes in Shorewall 4.0.0 Final.
None. 1) The Perl modules in /usr/share/shorewall-perl/Shorewall/ have been
consolidated somewhat, leading to slightly faster compilation.
Migration Considerations: Migration Considerations:

View File

@ -23,8 +23,8 @@
# This module is responsible for lower level configuration file handling. # This module is responsible for lower level configuration file handling.
# It also exports functions for generating warning and error messages. # It also exports functions for generating warning and error messages.
# The get_configuration function parses the shorewall.conf, capabilities and # The get_configuration function parses the shorewall.conf, capabilities and
# modules files during compiler startup. The module also provides very basic # modules files during compiler startup. The module also provides the basic
# services such as creation of temporary 'object' files, writing # output file services such as creation of temporary 'object' files, writing
# into those files (emitters) and finalizing those files (renaming # into those files (emitters) and finalizing those files (renaming
# them to their final name and setting their mode appropriately). # them to their final name and setting their mode appropriately).
# #
@ -96,15 +96,38 @@ our @EXPORT = qw(
our @EXPORT_OK = qw( $shorewall_dir initialize read_a_line1 set_config_path ); our @EXPORT_OK = qw( $shorewall_dir initialize read_a_line1 set_config_path );
our $VERSION = 4.00; our $VERSION = 4.00;
#
# describe the current command, it's present progressive, and it's completion.
#
our ($command, $doing, $done ); our ($command, $doing, $done );
#
# VERBOSITY
#
our $verbose; our $verbose;
#
# Timestamp each progress message, if true.
#
our $timestamp; our $timestamp;
#
# Object file handle
#
our $object; our $object;
#
# True, if last line emitted is blank
#
our $lastlineblank; our $lastlineblank;
#
# Number of columns to indent the output
#
our $indent; our $indent;
our ( $dir, $file ); # Object's Directory and File #
our $tempfile; # Temporary File Name # Object's Directory and File
#
our ( $dir, $file );
#
# Temporary output file's name
#
our $tempfile;
# #
# Misc Globals # Misc Globals
# #
@ -144,9 +167,9 @@ our $currentfile; # File handle reference
our $currentfilename; # File NAME our $currentfilename; # File NAME
our $currentlinenumber; # Line number our $currentlinenumber; # Line number
our $shorewall_dir; #Shorewall Directory our $shorewall_dir; # Shorewall Directory
our $debug; our $debug; # If true, use Carp to report errors with stack trace.
# #
# Initialize globals -- we take this novel approach to globals initialization to allow # Initialize globals -- we take this novel approach to globals initialization to allow
@ -441,7 +464,6 @@ sub emitj {
# #
# Write passed message to the object with newline but no indentation. # Write passed message to the object with newline but no indentation.
# #
sub emit_unindented( $ ) { sub emit_unindented( $ ) {
print $object "$_[0]\n" if $object; print $object "$_[0]\n" if $object;
} }