add more documentation to top of file explaining what file does

webtools/tinderbox2/src/bin/addnote.cgi

@@ -2,8 +2,12 @@
 # -*- Mode: perl; indent-tabs-mode: nil -*-
 #
 
-# $Revision: 1.4 $ 
-# $Date: 2000/11/09 19:19:32 $ 
+# addnote.cgi - the webform which users enter notices to be displayed
+#		 on the tinderbox status page.
+
+
+# $Revision: 1.5 $ 
+# $Date: 2001/01/04 00:24:50 $ 
 # $Author: kestes%staff.mail.com $ 
 # $Source: /home/hwine/cvs_conversion/cvsroot/mozilla/webtools/tinderbox2/src/bin/addnote.cgi,v $ 
 # $Name:  $ 

webtools/tinderbox2/src/bin/gunzip.cgi

@@ -2,8 +2,16 @@
 # -*- Mode: perl; indent-tabs-mode: nil -*-
 #
 
-# $Revision: 1.4 $ 
-# $Date: 2000/11/09 19:20:12 $ 
+# gunzip.cgi - This cgi script will gunzip a file and send the result
+# to standard out in a form that a webserver can display.  Filenames
+# are passed in via an abreviated form.  It is assumed that all files
+# are either brief or full log files which are stored in known
+# Tinderbox directories.  The file id is the basename of the file
+# without the '.gz.html' extension.
+
+
+# $Revision: 1.5 $ 
+# $Date: 2001/01/04 00:25:24 $ 
 # $Author: kestes%staff.mail.com $ 
 # $Source: /home/hwine/cvs_conversion/cvsroot/mozilla/webtools/tinderbox2/src/bin/gunzip.cgi,v $ 
 # $Name:  $ 

webtools/tinderbox2/src/bin/processmail_bugs

@@ -3,18 +3,23 @@
 #
 
 # processmail_bugs - The 'bug tracking' mail processing engine for
-# tinderbox.  The bug tracking server (bugzilla, aim, remedy) send
-# mail to the tinderbox server, when bug tickets change state. This
-# program will parse the most common mail formats and and tell the
-# tinderbox server about the tickets.  Tinderbox will display summary
+# tinderbox.  The bug tracking server (bugzilla, aim, remedy, etc.)
+# send mail to the tinderbox server, when bug tickets change
+# state. This program will parse the most common mail formats and and
+# tell the tinderbox server about the tickets.  This program should be
+# run by the MTA (Sendmail) when ever mail for the tinderboxs
+# bugtracking mail account arrives.  Tinderbox will display summary
 # information about these tickets on the same page as the build and
 # version control information.  The Bug Tracking modules are designed
 # to be very flexible and work with any bug tracking system, they may
-# require technical configurations.
+# require technical configurations.  No locks are used by the mail
+# processes, data is passed to the tinderbox server in a maildir like
+# format.
 
 
-# $Revision: 1.4 $ 
-# $Date: 2000/11/28 00:35:37 $ 
+
+# $Revision: 1.5 $ 
+# $Date: 2001/01/04 00:25:39 $ 
 # $Author: kestes%staff.mail.com $ 
 # $Source: /home/hwine/cvs_conversion/cvsroot/mozilla/webtools/tinderbox2/src/bin/processmail_bugs,v $ 
 # $Name:  $ 

webtools/tinderbox2/src/bin/rmlogs

@@ -3,10 +3,11 @@
 #
 
 # rmlogs - remove the log files which are older then the number of
-#          days set in TinderConfig.  This program should be run from cron.
+#          days set in TinderConfig.  This program should be 
+# 	   run from cron daily.
 
-# $Revision: 1.3 $ 
-# $Date: 2000/11/09 19:21:27 $ 
+# $Revision: 1.4 $ 
+# $Date: 2001/01/04 00:26:00 $ 
 # $Author: kestes%staff.mail.com $ 
 # $Source: /home/hwine/cvs_conversion/cvsroot/mozilla/webtools/tinderbox2/src/bin/rmlogs,v $ 
 # $Name:  $ 

webtools/tinderbox2/src/bin/tinder.cgi

@@ -2,14 +2,14 @@
 # -*- Mode: perl; indent-tabs-mode: nil -*-
 #
 
-# $Revision: 1.9 $ 
-# $Date: 2000/11/09 19:21:44 $ 
+# $Revision: 1.10 $ 
+# $Date: 2001/01/04 00:26:16 $ 
 # $Author: kestes%staff.mail.com $ 
 # $Source: /home/hwine/cvs_conversion/cvsroot/mozilla/webtools/tinderbox2/src/bin/tinder.cgi,v $ 
 # $Name:  $ 
 
-# tinder - the main tinderbox program.  This program make all the HTML
-# pages.
+# tinder.cgi - the main tinderbox program.  This program make all the 
+# 		HTML pages.
 
 # The contents of this file are subject to the Mozilla Public
 # License Version 1.1 (the "License"); you may not use this file

webtools/tinderbox2/src/default_conf/Error_Parse.pm

@@ -1,11 +1,12 @@
 # -*- Mode: perl; indent-tabs-mode: nil -*-
 
-# Error_Parser.pm - parsing functions for build errors reported by
-# various tools/OS's.  Used by processmail to turn the build logs into
-# HTML.
+# Error_Parser.pm - Used by processmail to turn the build logs into
+# HTML.  Contains the parsing functions for highlighting the build
+# errors and creating links into the source code where the errors
+# occurred.
 
-# $Revision: 1.1 $ 
-# $Date: 2000/11/29 20:53:19 $ 
+# $Revision: 1.2 $ 
+# $Date: 2001/01/04 00:24:25 $ 
 # $Author: kestes%staff.mail.com $ 
 # $Source: /home/hwine/cvs_conversion/cvsroot/mozilla/webtools/tinderbox2/src/default_conf/Error_Parse.pm,v $ 
 # $Name:  $ 

webtools/tinderbox2/src/default_conf/FileStructure.pm

@@ -3,11 +3,11 @@
 # FileStructure.pm - The lookup for where different file/directories,
 # for each tree, are stored on the filesystem.  Local system
 # administrator may need to put different trees onto different disk
-# partitions and this will require making get_filename() less regular
-# then we have defined it here.
+# partitions and this will require making directory structure in
+# get_filename() less regular then we have defined it here.
 
-# $Revision: 1.1 $ 
-# $Date: 2000/11/29 20:53:25 $ 
+# $Revision: 1.2 $ 
+# $Date: 2001/01/04 00:24:36 $ 
 # $Author: kestes%staff.mail.com $ 
 # $Source: /home/hwine/cvs_conversion/cvsroot/mozilla/webtools/tinderbox2/src/default_conf/FileStructure.pm,v $ 
 # $Name:  $ 

webtools/tinderbox2/src/lib/VCDisplay.pm

@@ -1,6 +1,6 @@
 # -*- Mode: perl; indent-tabs-mode: nil -*-
 
-# The VCDisplay module describes how tinderbox should prepeare URLS to
+# VCDisplay.pm - describes how tinderbox should prepeare URLS to
 # show the source tree allow VC queries.  Currently there are two
 # implementations one for users of the bonsai system (cvsquery,
 # cvsguess, cvsblame) and one for users who have no web based access
@@ -8,8 +8,8 @@
 # VCDisplay module for CVSWeb.
 
 
-# $Revision: 1.3 $ 
-# $Date: 2000/11/09 19:28:42 $ 
+# $Revision: 1.4 $ 
+# $Date: 2001/01/04 00:23:24 $ 
 # $Author: kestes%staff.mail.com $ 
 # $Source: /home/hwine/cvs_conversion/cvsroot/mozilla/webtools/tinderbox2/src/lib/VCDisplay.pm,v $ 
 # $Name:  $