[Sandweb-commit] CVS: sandweb/lib/SandWeb/Repository cvs.pm,1.22,1.23

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

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

Modified Files:
	cvs.pm 
Log Message:
added more comments


Index: cvs.pm
===================================================================
RCS file: /cvsroot/sandweb/sandweb/lib/SandWeb/Repository/cvs.pm,v
retrieving revision 1.22
retrieving revision 1.23
diff -U2 -r1.22 -r1.23
--- cvs.pm	19 Jun 2002 06:47:07 -0000	1.22
+++ cvs.pm	19 Jun 2002 06:52:20 -0000	1.23
@@ -32,15 +32,40 @@
 	my %args = @_;
 
+	# root is the path on the remote file system to the CVS repository
 	my $root = $args{'root'} || '';
+
+	# sandbox is the local directory that the user's sandbox for this
+	# repo begins
 	my $sandbox = $args{'sandbox'} || '';
+
+	# connection is the CVS connection type, SSH, pserver, local, etc
 	my $connection = $args{'connection'} || '';
+
+	# server is the name of the CVS server
 	my $server = $args{'server'} || '';
+
+	# ssh_bin is the full path and name of the local SSH binary ( optional )
 	my $ssh_bin = $args{'ssh_bin'} || '';
+
+	# cvs_bin is the full path and name of the local CVS binary ( required )
 	my $cvs_bin = $args{'cvs_bin'} || '';
+
+	# bindir is the full path to the local SandWeb binary dir, this is where
+	# we store scripts like sandweb-expect and sandweb-admin
 	my $bindir = $args{'bindir'} || '';
+
+	# vcs_username is the user's name on the CVS server ( optional )
 	my $vcs_username = $args{'vcs_username'} || '';
+
+	# vcs_password is the user's password on the CVS server ( optional )
 	my $vcs_password = $args{'vcs_password'} || '';
+
+	# system_username is the user's username on the local box ( optional )
 	my $system_username = $args{'system_username'} || '';
+
+	# system_password is the user's password on the local box ( optional )
 	my $system_password = $args{'system_password'} || '';
+
+	# log is a reference to an object based on the SandWeb::Log class
 	my $log = $args{'log_obj'} || '';