[cisco-stats] Updated comments and unified style.
authorMaximilian Wilhelm <max@rfc2324.org>
Sat, 5 Jan 2008 21:49:40 +0000 (22:49 +0100)
committerMaximilian Wilhelm <max@rfc2324.org>
Sat, 5 Jan 2008 21:49:40 +0000 (22:49 +0100)
Signed-off-by: Maximilian Wilhelm <max@rfc2324.org>

cisco-stats/generate_cisco_port_configuration_overview

index ff3a0e9..eddec30 100755 (executable)
@@ -17,7 +17,8 @@ use strict;
 
 use Getopt::Long;
 
-# command line options
+#
+# Parse command line options
 my $opt = {};
 
 Getopt::Long::Configure ("bundling");
@@ -29,26 +30,33 @@ GetOptions (
 );
 
 
+#
 # The device/hostname
 my $device_name = undef;
 
+#
 # Hash with ports to be included
 #  By default all ports shall be included, therefore no list -> undef
 my $include_ports = undef;
 
+#
 # Hash with interfaces
 #  Top level keys: Interface type (FastEthernet, GigabitEthernet, ...)
 #  2nd level keys: Module or interface number
 #  optional 3rd level keys: interface number in case of modules.
 my $interfaces = {};
 
+#
 # Hash to mark all found vlans
 #  keys: vlan ID
 #  values: something...
 my $vlans = {};
 
+#
+# All required options given? / Asked for help?
 if (! defined $opt->{filename} || defined $opt->{help}) {
-       print STDERR "Usage: $0 --file filename\n";
+       print STDERR "Usage: $0\n";
+       print STDERR "\t--file filename | -f\n";
        print STDERR "\t[--help | -h]\n";
        print STDERR "\t[--include int1[,int2[...]] | -i]\n";
        print STDERR "\t[--ignore_shutdown_interfaces]\n";
@@ -63,8 +71,9 @@ my $line_num = 0;
 open (RUNNING_CONFIG, "< $opt->{filename}")
        or die "Could not open file \"$opt->{filename}\": $!\n";
 
-
-if (defined $opt->{include}) {
+#
+# Limit output to listed interfaces?
+if (defined $opt->{include}) { # {{{
        $include_ports = {};
 
        # Just put all given ports into the hash
@@ -77,7 +86,7 @@ if (defined $opt->{include}) {
 
                $include_ports->{$port} = 42;
        }
-}
+} # }}}
 
 
 while (my $line = <RUNNING_CONFIG>) { # Read device configuration {{{
@@ -237,6 +246,7 @@ while (my $line = <RUNNING_CONFIG>) { # Read device configuration {{{
 
 close (RUNNING_CONFIG);
 
+#
 # Got a device/hostname?
 if (! defined $device_name) {
        $device_name = "unknown device";