[Sandweb-commit] CVS: sandweb/lib/SandWeb Shell.pm,1.12,1.13

[Rob H. <for...@us...>]

Update of /cvsroot/sandweb/sandweb/lib/SandWeb
In directory usw-pr-cvs1:/tmp/cvs-serv24002/lib/SandWeb

Modified Files:
	Shell.pm 
Log Message:
added more comments to the Shell class


Index: Shell.pm
===================================================================
RCS file: /cvsroot/sandweb/sandweb/lib/SandWeb/Shell.pm,v
retrieving revision 1.12
retrieving revision 1.13
diff -U2 -r1.12 -r1.13
--- Shell.pm	19 Jun 2002 06:30:36 -0000	1.12
+++ Shell.pm	19 Jun 2002 06:55:36 -0000	1.13
@@ -26,11 +26,31 @@
 	my %args = @_;
 
+	# bindir is the full path on the local box to SandWeb's scripts, like
+	# sandweb-expect and sandweb-admin
 	my $bindir = $args{'bindir'} || '';
+
+	# system_username is the user's username on the local box ( optional )
 	my $system_username = $args{'system_username'} || '';
+
+	# system_username is the user's password on the local box ( optional )
 	my $system_password = $args{'system_password'} || '';
+
+	# system_username is the user's VCS username on the local box 
+	# ( optional )
 	my $vcs_username = $args{'vcs_username'} || '';
+
+	# system_username is the user's VCS password on the local box 
+	# ( optional )
 	my $vcs_password = $args{'vcs_password'} || '';
+
+	# system is true if the user wants to authenticate with the OS, false
+	# if they do not
 	my $system = $args{'system'} || '';
+
+	# vcs is true if the user wants to authenticate with the VCS, false
+	# if they do not
 	my $vcs = $args{'vcs'} || '';
+
+	# log is a reference to an object based on the SandWeb::Log class
 	my $log = $args{'log_obj'} || '';
 
@@ -53,5 +73,8 @@
 	my %args = @_;
 
+	# sandweb-expect is an Expect script that handles username/password
+	# authentication for SandWeb
 	my $sandweb_expect = "$self->{'bindir'}/sandweb-expect";
+
 	my $system_username = $self->{'system_username'};
 	my $system_password = $self->{'system_password'};