branchGraph.readme.txt #1

branchGraph.cgi CGI script (by Todd Short)

All I ask for is credit! :)

This script will generate a PNG file that graphically depicts the 
branching and merging relationships between files. This script
requires P4DB 2.0. The script requires GD to be installed (I
used GD 1.8.4) and the GD.pm Perl module (I used version 1.33).

P4DB 2.0 is availble on the supporting programs page at Perforce's 
web site:
http://www.perforce.cisco.com/perforce/loadsupp.html

The GD library is available at:
http://www.boutell.com/gd

The GD.pm module is available at:
http://stein.cshl.org/WWW/software/GD/GD.html

The script is run twice, once for the HTML, and again to generate
the PNG. This was tested using P4/P4D 2001.1.

My Perl isn't pretty, but it works, and seems to do the job well.

Setup:
1. Place the script in the same location as the P4DB 2.0 files.
2. Edit the branchGraph.cgi script to update the location of perl.
3. Set the script up with your web server, probably just:
   chmod a+x branchGraph.cgi
4. Update the fileLogView.cgi script at roughly line 214 to add:

push @legendList,
    &P4CGI::ahref("-url","branchGraph.cgi",
		  "FSPC=$file",
		  "Graph Branches/Merges") .
    "-- Graph branches and merges to/from this file";

You can add more links in other places, this just seems like
an obvious place.
5. Done.

The parameters to the CGI script are:

FSPC=<depot file>

e.g.:

http://server/cgi-bin/branchGraph.cgi?FSPC=//depot/filename.c