[rt-devel] Makefile diffs

[Dan Shearer]

This is against the current CVS for 2.0. I've installed RT a few times but
this time wherever I found something unclear I tried to improve the
explanation. I'm not sure what the story is with the DB variable, has it
been dropped, Jesse?

Dan

--- ../rt/Makefile	Fri May  3 15:21:03 2002
+++ Makefile	Sat May  4 21:20:48 2002
@@ -24,26 +24,31 @@
 # User that should own all of RT's libraries, generally root.
 LIBS_OWNER 		=	root
 
-# Group that should own all of RT's libraries, generally root.
-LIBS_GROUP		=	bin
+# Group that should own all of RT's libraries, generally root 
+
+LIBS_GROUP		=	root
 
 
 
 # {{{ Files and directories 
 
 # DESTDIR allows you to specify that RT be installed somewhere other than
-# where it will eventually reside
+# where it will eventually reside, ie what you are specifying here is an
+# interim staging directory such as you might use for testing
 
 DESTDIR			=	
 
 
-# RT_PATH is the name of the directory you want make to install RT in
-# RT must be installed in its own directory (don't set this to /usr/local)
+# RT_PATH is the name of the directory you want make to install RT in.
+# RT must be installed in its own directory (don't set this to a top-level
+# directory such as /usr/local or you will create a big mess.) Most Unixes
+# would tend to have either /opt/rt2 or /usr/local/rt2
 
 RT_PATH			=	/opt/rt2
 
 # The rest of these paths are all configurable, but you probably don't want to 
-# put them elsewhere
+# change them unless you have a very special need
 
 RT_LIB_PATH		=	$(RT_PATH)/lib
 RT_ETC_PATH		=	$(RT_PATH)/etc
@@ -54,19 +59,27 @@
 
 
 # RT allows sites to overlay the default web ui with 
-# local customizations Those files can be placed in MASON_LOCAL_HTML_PATH
+# local customizations. Such files can be placed in MASON_LOCAL_HTML_PATH
 
 MASON_LOCAL_HTML_PATH	=	$(RT_PATH)/local/WebRT/html
 
-# RT needs to be able to write to MASON_DATA_PATH and MASON_SESSION_PATH
+# RT needs to be able to write to MASON_DATA_PATH and MASON_SESSION_PATH.
 # RT will create and chown these directories. Don't just set them to /tmp
+# or any other top-level directory
 MASON_DATA_PATH		=       $(RT_PATH)/WebRT/data
 MASON_SESSION_PATH	=       $(RT_PATH)/WebRT/sessiondata
 
+# The log path should be a new directory where you normally keep logs,
+# such as /var/log/rt2. The default /tmp will work (because there is only
+# one file, this time a top-level directory is ok) but is a bad idea
+# especially for Unixes which wipe /tmp on every boot by default.
+# RT will not create this directory or change its permissions, so you 
+# will need to make your your web server has write access to it. RT will
+# not work at all if this file cannot be found or written to.
 RT_LOG_PATH             =       /tmp
 
 # RT_READABLE_DIR_MODE is the mode of directories that are generally meant
-# to be accessable
+# to be accessible such as ones containing HTML
 RT_READABLE_DIR_MODE	=	0755
 
 
@@ -78,11 +91,11 @@
 RT_MODPERL_HANDLER	=	$(RT_BIN_PATH)/webmux.pl
 
 # RT_FASTCGI_HANDLER is the mason handler script for FastCGI
-# THIS HANDLER IS NOT CURRENTLY SUPPORTED
+# THIS HANDLER IS NOT CURRENTLY SUPPORTED, USE AT GREAT RISK
 RT_FASTCGI_HANDLER	=	$(RT_BIN_PATH)/mason_handler.fcgi
 
 # RT_SPEEDYCGI_HANDLER is the mason handler script for SpeedyCGI
-# THIS HANDLER IS NOT CURRENTLY SUPPORTED
+# THIS HANDLER IS NOT CURRENTLY SUPPORTED, USE AT GREAT RISK
 RT_SPEEDYCGI_HANDLER	=	$(RT_BIN_PATH)/mason_handler.scgi
 
 # The following are the names of the various binaries which make up RT 
@@ -105,12 +118,15 @@
 
 # DB_HOME is where the Database's commandline tools live.  $DB_HOME/bin
 # should contain the binaries themselves, e.g. if "which mysql" gives
-# "/usr/local/mysql/bin/mysql", $DB_HOME should be "/usr/local/mysql"
+# "/usr/local/mysql/bin/mysql", $DB_HOME should be "/usr/local/mysql".
+# For Postgresql try "which pgsql".
 
 DB_HOME			= /usr
 
 # Set DBA to the name of a unix account with the proper permissions and 
 # environment to run your commandline SQL tools
+# Jesse I haven't checked in the code but the following line might be missing
+DBA                     = root
 
 # Set DB_DBA to the name of a DB user with permission to create new databases 
 # Set DB_DBA_PASSWORD to that user's password (if you don't, you'll be prompted
@@ -126,18 +142,19 @@
 #
 # Set this to the Fully Qualified Domain Name of your database server.
 # If the database is local, rather than on a remote host, using "localhost" 
-# will greatly enhance performance.
+# may greatly enhance performance if your Unix doesn't optimise network
+# connections very well
 
 DB_HOST			=	localhost
 
 # If you're not running your database server on its default port, 
-# specifiy the port the database server is running on below.
-# It's generally safe to leave this blank 
+# specify the port the database server is running on below.
+# It's generally safe to leave this blank. RT knows the default settings
+# for the databases it supports.
 
 DB_PORT			=	
 
-#
-# Set this to the canonical name of the interface RT will be talking to the 
+# Set this to the canonical name of the IP address RT will be talking to the 
 # database on.  If you said that the RT_DB_HOST above was "localhost," this 
 # should be too. This value will be used to grant rt access to the database.
 # If you want to access the RT database from multiple hosts, you'll need
@@ -156,16 +173,16 @@
 DB_RT_USER		=	rt_user
 
 # Set this to the password used by the rt database user
-# *** Change This Before Installation***
+# *** Change This Before Installation, it is deliberately invalid! ***
 
-DB_RT_PASS		=	rt_pass
+DB_RT_PASS		=	|||||||
 
 # }}}
 
 # {{{ Web configuration 
 
-# The user your webserver runs as. needed so that webrt can cache mason
-# objectcode
+# The user your webserver runs as. Needed so that webrt can cache mason
+# objectcode. Common web users are www, apache and httpd.
 
 WEB_USER		=	www
 WEB_GROUP		=	rt